Skip to content
Sigilry Sigilry Sigilry

UseContractStreamOptions

Defined in: packages/react/src/hooks/useContractStream.ts:29

Properties

Section titled “Properties”

enabled?

Section titled “enabled?”

optional enabled: boolean

Defined in: packages/react/src/hooks/useContractStream.ts:35

Whether to enable the stream (default: true when connected)

newDuration?

Section titled “newDuration?”

optional newDuration: number

Defined in: packages/react/src/hooks/useContractStream.ts:37

Duration to keep isNew flag (ms, default: 2000)

onChange()?

Section titled “onChange()?”

optional onChange: (contracts) => void

Defined in: packages/react/src/hooks/useContractStream.ts:41

Callback when contracts change

Parameters

Section titled “Parameters”
contracts
Section titled “contracts”

StreamedContract[]

Returns

Section titled “Returns”

void

pollingInterval?

Section titled “pollingInterval?”

optional pollingInterval: number

Defined in: packages/react/src/hooks/useContractStream.ts:33

Polling interval in milliseconds (default: 2000)

removeDuration?

Section titled “removeDuration?”

optional removeDuration: number

Defined in: packages/react/src/hooks/useContractStream.ts:39

Duration to keep isRemoving before actually removing (ms, default: 500)

templateFilter?

Section titled “templateFilter?”

optional templateFilter: CantonTemplateFilter

Defined in: packages/react/src/hooks/useContractStream.ts:31

Template filter for contracts to watch