ShardlensClientOptions
Defined in: packages/client/src/transport.ts:4
Options of createShardlensClient.
Properties
Section titled “Properties”apiKey
Section titled “apiKey”apiKey:
string
Defined in: packages/client/src/transport.ts:14
A read key (slk_read_…) or, to read the activity log as well, an activity key (slk_activity_…). Keep it on
your server: a key in a browser can be read by every visitor.
endpoint
Section titled “endpoint”endpoint:
string
Defined in: packages/client/src/transport.ts:9
Your collector’s address, such as https://stats.example.com: the SDK’s endpoint (SHARDLENS_URL). HTTPS, or
HTTP to localhost only, and no path.
fetch?
Section titled “fetch?”
optionalfetch?: {(input,init?):Promise<Response>; (input,init?):Promise<Response>; }
Defined in: packages/client/src/transport.ts:18
The fetch to send requests with. Default: the global one.
Call Signature
Section titled “Call Signature”(
input,init?):Promise<Response>
Parameters
Section titled “Parameters”URL | RequestInfo
RequestInit
Returns
Section titled “Returns”Promise<Response>
Call Signature
Section titled “Call Signature”(
input,init?):Promise<Response>
Parameters
Section titled “Parameters”string | URL | Request
RequestInit
Returns
Section titled “Returns”Promise<Response>
timeoutMs?
Section titled “timeoutMs?”
optionaltimeoutMs?:number
Defined in: packages/client/src/transport.ts:16
How long a request may take, and how long a live stream may take to connect, in milliseconds. Default 10,000.