Skip to content

⬅️ Back to Table of Contents

📄 reactifyObject

📊 Analysis Summary

Metric Count
🔧 Functions 1
📦 Imports 4
📐 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

Functions

reactifyObject(obj: T, keys: (keyof T)[]): ReactifyObjectReturn<T, Keys, true>

Apply reactify to an object

Tags: @__NO_SIDE_EFFECTS__

Raw JSDoc 
/**
 * Apply `reactify` to an object
 *
 * @__NO_SIDE_EFFECTS__
 */
Code 
export function reactifyObject<T extends object, Keys extends keyof T>(obj: T, keys?: (keyof T)[]): 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 ✓ not shown

Type Aliases

ReactifyNested<T, Keys extends keyof T = keyof T, S extends boolean = true>

type ReactifyNested<T, Keys extends keyof T = keyof T, S extends boolean = true> = { [K in Keys]: T[K] extends AnyFn ? Reactified<T[K], S> : T[K] };

ReactifyObjectReturn<T, Keys extends keyof T, S extends boolean = true>

type ReactifyObjectReturn<T, Keys extends keyof T, S extends boolean = true> = ReactifyNested<T, Keys, S>;

Generated by Syntax Scribe