Skip to main content

Function: useEntity()

useEntity<S>(type, params): { data: any; invalidEntity: null | Record<string, string | number | boolean | unknown[] | Date>; } | { data: any; invalidEntity: null | Record<string, string | number | boolean | unknown[] | Date>; } | { data: any; invalidEntity: null | Record<string, string | number | boolean | unknown[] | Date>; } | { data: any; invalidEntity: null | Record<string, string | number | boolean | unknown[] | Date>; } | { data: any; invalidEntity: null | Record<string, string | number | boolean | unknown[] | Date>; } | { data: any; invalidEntity: undefined | Record<string, string | number | boolean | Date>; isError: boolean; isPending: boolean; }

Defined in: packages/hypergraph-react/src/hooks/use-entity.tsx:6

Type Parameters​

S​

S extends AnyNoContext

Parameters​

type​

S

params​

id​

any

include?​

{ [K in string | number | symbol]?: Record<string, Record<string, never>> }

mode​

"private" | "public"

space?​

string

Returns​

{ data: any; invalidEntity: null | Record<string, string | number | boolean | unknown[] | Date>; } | { data: any; invalidEntity: null | Record<string, string | number | boolean | unknown[] | Date>; } | { data: any; invalidEntity: null | Record<string, string | number | boolean | unknown[] | Date>; } | { data: any; invalidEntity: null | Record<string, string | number | boolean | unknown[] | Date>; } | { data: any; invalidEntity: null | Record<string, string | number | boolean | unknown[] | Date>; } | { data: any; invalidEntity: undefined | Record<string, string | number | boolean | Date>; isError: boolean; isPending: boolean; }