Hoshimi Docs

Signature

export interface RestOptions

No methods.

endpoint: RestEndpoint;

The endpoint for the REST.

@type{RestEndpoint}

method?: HttpMethods;

The method for the REST.

@type{HttpMethods}

headers?: Record<string, string>;

The headers for the REST.

@type{Record<string, string>}

body?: Record<string, unknown> | string;

The body for the REST.

@type{Record<string, unknown> | string | undefined}

params?: Record<string, string>;

The query parameters for the REST.

@type{Record<string, string>}

pathType?: RestPathType;

The path type for the REST.

@type{RestPathType}