Skip to main content

CommsApiOptions

type CommsApiOptions = {
baseUrl?: string;
customFetch?: CustomFetch;
headers?: CustomHeaders;
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).


headers?​

optional headers?: CustomHeaders;

Optional headers sent with every request, e.g. { 'Doist-Platform': 'cli' } for client attribution. Pass a function instead to compute them per request, e.g. a fresh request ID; it is called once per request and retries reuse its result. Cannot override Authorization or X-Request-Id.


version?​

optional version?: ApiVersion;

Optional API version. Defaults to 'v1.0'.