Skip to main content

API Reference

This section serves as a reference for the key TypeScript types and interfaces used as props in the DIDSpaceConnect and DIDSpaceConnection components. Understanding these data structures is essential for developers to leverage the full power of the library, ensure type safety, and correctly configure the components in a TypeScript environment.

Before diving into the types, you might want to review the Components documentation to see how they are used in practice.

Our components rely on a set of well-defined data structures to manage state and configuration. The core types you will encounter include:

  • DIDSpaceGateway: Represents the connection details for a specific DID Space.
  • DIDSpaceStatus: An enum that tracks the current connection status (CONNECTED, DISCONNECTED, etc.).
  • AuthorizeConnect: Defines the configuration for the connection authorization modal.
  • GatewayAuthOptions: Specifies options for authenticating with a DID Space gateway.

For detailed information on each type, including all properties and their descriptions, please refer to the Types documentation.

Types

Dive into the detailed documentation of key data types like DIDSpaceGateway, DIDSpaceStatus, AuthorizeConnect, and other interfaces used throughout the component library's props. This is essential for robust TypeScript development.

View Type Details

After reviewing the type definitions, a great next step is to see them in action within the component examples. Return to the Components section to apply what you've learned.