Skip to content

Class: Hooks<CN, Bounded>

Defined in: src/betterdiscord/api/hooks.ts:17

Hooks is a utility class providing access to various React hooks. An instance is available on BdApi.

Type Parameters

Type ParameterDefault type
CN extends string | undefinedundefined
Bounded extends IsTruthy<CN>IsTruthy<CN>

Properties

useForceUpdate()

ts
useForceUpdate: () => [number, ActionDispatch<any>];

Defined in: src/betterdiscord/api/hooks.ts:26

Returns

[number, ActionDispatch<any>]


useStateFromStores()

ts
useStateFromStores: <T>(stores: 
  | StoreType
  | StoreType[], factory: () => T, deps?: DependencyList, areStateEqual: true | (oldState: T, newState: T) => boolean) => T;

Defined in: src/betterdiscord/api/hooks.ts:25

Type Parameters

Type Parameter
T

Parameters

ParameterType
stores| StoreType | StoreType[]
factory() => T
deps?DependencyList
areStateEqual?true | (oldState: T, newState: T) => boolean

Returns

T

Methods

useData()

ts
useData<T>(...args: [...(Bounded extends false ? [pluginName: string] : [])[], string]): T;

Defined in: src/betterdiscord/api/hooks.ts:28

Type Parameters

Type Parameter
T

Parameters

ParameterType
...args[...(Bounded extends false ? [pluginName: string] : [])[], string]

Returns

T