Skip to main content

Interface: BeeOptions

Defined in: bee-js/src/types/index.ts:68

Options for the Bee client which affect all method calls (unless overridden in the method call itself).

Extends BeeRequestOptions, which allows configuring the HTTP client behavior, such as timeout, additional headers, custom httpAgent, etc.

Extends​

Properties​

baseURL?​

optional baseURL: string

Defined in: bee-js/src/types/index.ts:52

Inherited from​

BeeRequestOptions.baseURL

endlesslyRetry?​

optional endlesslyRetry: boolean

Defined in: bee-js/src/types/index.ts:58

Inherited from​

BeeRequestOptions.endlesslyRetry

headers?​

optional headers: Record<string, string>

Defined in: bee-js/src/types/index.ts:54

Inherited from​

BeeRequestOptions.headers

httpAgent?​

optional httpAgent: unknown

Defined in: bee-js/src/types/index.ts:56

Inherited from​

BeeRequestOptions.httpAgent

httpsAgent?​

optional httpsAgent: unknown

Defined in: bee-js/src/types/index.ts:57

Inherited from​

BeeRequestOptions.httpsAgent

network?​

optional network: "gnosis" | "sepolia"

Defined in: bee-js/src/types/index.ts:87

Network on which the Bee node is running.

This is currently used to determine block time for postage batch time-to-live (TTL) calculations. The block time for gnosis is 5 seconds, and for sepolia it is 15 seconds.

Default value is gnosis.

onRequest()?​

optional onRequest: (request) => void

Defined in: bee-js/src/types/index.ts:55

Parameters​

request​

BeeRequest

Returns​

void

Inherited from​

BeeRequestOptions.onRequest

signal?​

optional signal: AbortSignal

Defined in: bee-js/src/types/index.ts:59

Inherited from​

BeeRequestOptions.signal

signer?​

optional signer: string | Uint8Array<ArrayBufferLike> | PrivateKey

Defined in: bee-js/src/types/index.ts:77

Default signer (a private key) used for signing.

Mainly used in single-owner chunk (SOC) related operations, and consequently in feeds.

If not provided, methods such as makeFeedWriter and makeSOCWriter must be provided with a private key in their respective function calls.

timeout?​

optional timeout: number

Defined in: bee-js/src/types/index.ts:53

Inherited from​

BeeRequestOptions.timeout

💬 Get Help