ntcore-ts / @ntcore-ts/react / UseStructTopicOptions

Type Alias: UseStructTopicOptions<T>

UseStructTopicOptions<T> = object

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

Options for useStructTopic (defaultValue, validator, typeName, schema, subscribeOptions, publish).

Type Parameters

T

T extends object | object[] = object

Properties

defaultValue?

optional defaultValue?: T

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

---

publish?

optional publish?: true | TopicProperties

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

Make this client the publisher of the topic so you can write with setValue. When provided, only call setValue after isReadyToWrite is true.

---

schema?

optional schema?: string

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

---

subscribeOptions?

optional subscribeOptions?: SubscribeOptions

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

---

typeName?

optional typeName?: string

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

---

unpublishOnUnmount?

optional unpublishOnUnmount?: boolean

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

When publish is set, call topic.unpublish() on unmount (default true).

---

validator?

optional validator?: ZodType<T>

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