Run as Library
Welcome to the API Reference for our Anyone Network Library. This documentation provides detailed information about the classes and methods available in our library, allowing you to integrate the functionality of the anon binary into your applications effectively.
Overview
Currently our library consists of three main classes, each serving a specific purpose in interacting with the Anyone Network:
Anon: This class allows you to run and manage an anon process with various configuration options. It provides methods to start and stop the Anon process, check its status, and retrieve port information.
AnonSocksClient: This class enables you to send HTTP requests through the Anon network using a SOCKS proxy. It wraps around the Axios library, providing methods for common HTTP operations like GET, POST, PUT, DELETE, and PATCH.
AnonControlClient: This class facilitates interaction with the Anon Control Port, allowing you to authenticate, send commands, and manage circuits within the Anon network.
How to Use This Documentation
Each class has its own dedicated page in this API Reference. On these pages, you'll find:
Detailed descriptions of the class constructor and its parameters
A list of all available methods, their parameters, and return types
Explanations of key concepts and data structures used by the class
Usage examples to help you get started
Quick Links
Last updated
Was this helpful?