ntcore-ts / @ntcore-ts/react / UseStructTopicResult

Type Alias: UseStructTopicResult<T>

UseStructTopicResult<T> = object

Defined in: react/src/lib/use-struct-topic.ts:37

Result of useStructTopic. When you pass publish, setValue is defined and you must wait for isReadyToWrite before calling it.

Type Parameters

T

T extends object | object[]

Properties

error

error: Error | null

Defined in: react/src/lib/use-struct-topic.ts:42

---

isReadyToWrite

isReadyToWrite: boolean

Defined in: react/src/lib/use-struct-topic.ts:41

True once the server has acknowledged our publish request.

---

setValue

setValue: ((value) => void) | undefined

Defined in: react/src/lib/use-struct-topic.ts:39

---

value

value: T | null

Defined in: react/src/lib/use-struct-topic.ts:38