Skip to main content

API Reference Overview

This section provides detailed documentation for the primary classes, methods, and options available in the NetRay library.

Choose a specific component from the sidebar to view its detailed API:

  • NetRay: The main entry point module required in scripts. Provides functions for registering events, requests, middleware, and accessing debug features.
  • ServerEvent: Handles server-side logic for unidirectional events.
  • ClientEvent: Handles client-side logic for unidirectional events.
  • RequestServer: Handles server-side logic for request/response patterns.
  • RequestClient: Handles client-side logic for request/response patterns using Promises.
  • CircuitBreaker: Provides fault tolerance for network operations.
  • Shared Modules: Learn more about internal components like Type Checking, Priorities, etc., in the Advanced Features section.