Skip to main content

CommsApiOptions

type CommsApiOptions = {
  baseUrl?: string;
  customFetch?: CustomFetch;
  version?: ApiVersion;
};

Properties​

baseUrl?​

optional baseUrl: string;

Optional custom API base URL. If not provided, defaults to Comms' standard API endpoint.

customFetch?​

optional customFetch: CustomFetch;

Optional custom fetch implementation for cross-platform compatibility (e.g., Obsidian, React Native, Electron).

version?​

optional version: ApiVersion;

Optional API version. Defaults to 'v1'.