⬅️ Back to Table of Contents
📄 index.ts
📊 Analysis Summary
Metric |
Count |
🔧 Functions |
1 |
📦 Imports |
4 |
📊 Variables & Constants |
3 |
📐 Interfaces |
1 |
📑 Type Aliases |
2 |
📚 Table of Contents
🛠️ File Location:
📂 packages/shared/reactifyObject/index.ts
📦 Imports
Name |
Source |
Reactified |
../reactify |
ReactifyOptions |
../reactify |
AnyFn |
../utils |
reactify |
../reactify |
Variables & Constants
Name |
Type |
Kind |
Value |
Exported |
keys |
string[] |
let/var |
[] |
✗ |
options |
ReactifyOptions<S> | undefined |
let/var |
*not shown* |
✗ |
value |
T[keyof T] |
const |
obj[key as keyof T] |
✗ |
Functions
reactifyObject(obj: T, keys: (keyof T)[]): ReactifyObjectReturn<T, Keys, true>
Code
export function reactifyObject<T extends object, Keys extends keyof T>(obj: T, keys?: (keyof T)[]): ReactifyObjectReturn<T, Keys, true>
-
JSDoc:
/**
* Apply `reactify` to an object
*/
-
Parameters:
obj: T
keys: (keyof T)[]
- Return Type:
ReactifyObjectReturn<T, Keys, true>
Interfaces
ReactifyObjectOptions<T extends boolean>
Interface Code
export interface ReactifyObjectOptions<T extends boolean> extends ReactifyOptions<T> {
/**
* Includes names from Object.getOwnPropertyNames
*
* @default true
*/
includeOwnProperties?: boolean
}
Properties
Name |
Type |
Optional |
Description |
includeOwnProperties |
boolean |
✓ |
|
Type Aliases
ReactifyNested<T, Keys extends keyof T = keyof T extends keyof T = keyof T, S extends boolean = true extends boolean = true>
type ReactifyNested<T, Keys extends keyof T = keyof T extends keyof T = keyof T, S extends boolean = true extends boolean = true> = { [K in Keys]: T[K] extends AnyFn ? Reactified<T[K], S> : T[K] };
ReactifyObjectReturn<T, Keys extends keyof T extends keyof T, S extends boolean = true extends boolean = true>
type ReactifyObjectReturn<T, Keys extends keyof T extends keyof T, S extends boolean = true extends boolean = true> = ReactifyNested<T, Keys, S>;