@deep-foundation/deeplinks

Version:

[![npm](https://img.shields.io/npm/v/@deep-foundation/deeplinks.svg)](https://www.npmjs.com/package/@deep-foundation/deeplinks) [![Gitpod](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/deep-fo

1 lines • 298 kB

HTML

View Raw

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DeepClientInstance | @deep-foundation/deeplinks</title><meta name="description" content="Documentation for @deep-foundation/deeplinks"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@deep-foundation/deeplinks</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@deep-foundation/deeplinks</a></li><li><a href="../modules/client.html">client</a></li><li><a href="client.DeepClientInstance.html">DeepClientInstance</a></li></ul><h1>Interface DeepClientInstance<L></h1></div><div class="tsd-signature">interface DeepClientInstance<<a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#L">L</a>> { <a class="tsd-kind-property" href="client.DeepClientInstance.html#apolloClient">apolloClient</a>: IApolloClient<any>; <a class="tsd-kind-property" href="client.DeepClientInstance.html#canSelectReturning">canSelectReturning</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#deep">deep</a>: <a href="client.DeepClientInstance.html" class="tsd-signature-type tsd-kind-interface">DeepClientInstance</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#L">L</a>>; <a class="tsd-kind-property" href="client.DeepClientInstance.html#DeepClient">DeepClient</a>: typeof <a href="../classes/client.DeepClient.html" class="tsd-signature-type tsd-kind-class">DeepClient</a>; <a class="tsd-kind-property" href="client.DeepClientInstance.html#DeepContext">DeepContext</a>: Context<<a href="../classes/client.DeepClient.html" class="tsd-signature-type tsd-kind-class">DeepClient</a><<a href="minilinks.Link.html" class="tsd-signature-type tsd-kind-interface">Link</a><<a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>>>>; <a class="tsd-kind-property" href="client.DeepClientInstance.html#DeepProvider">DeepProvider</a>: ((__namedParameters: { apolloClient?: IApolloClient<any>; children?: any; minilinks?: <a href="../classes/minilinks.MinilinkCollection.html" class="tsd-signature-type tsd-kind-class">MinilinkCollection</a><<a href="minilinks.MinilinksGeneratorOptions.html" class="tsd-signature-type tsd-kind-interface">MinilinksGeneratorOptions</a>, <a href="minilinks.Link.html" class="tsd-signature-type tsd-kind-interface">Link</a><<a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>>>; namespace?: string; path?: string; secret?: string; ssl?: boolean; token?: string; ws?: boolean; }) => Element); <a class="tsd-kind-property" href="client.DeepClientInstance.html#defaultDeleteName">defaultDeleteName</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#defaultInsertName">defaultInsertName</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#defaultSelectName">defaultSelectName</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#defaultUpdateName">defaultUpdateName</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#deleteReturning">deleteReturning</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#emitter">emitter</a>: EventEmitter<DefaultEventMap>; <a class="tsd-kind-property" href="client.DeepClientInstance.html#eval">eval</a>: ((options: { context?: <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>[]; handlerId?: <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>; input?: any; linkId?: <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>; value?: string; }) => Promise<{ data?: any; error?: any; }>); <a class="tsd-kind-property" href="client.DeepClientInstance.html#filesSelectReturning">filesSelectReturning</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#gql">gql</a>: typeof gql; <a class="tsd-kind-property" href="client.DeepClientInstance.html#handleAuth">handleAuth</a>?: ((linkId?: <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>, token?: string) => any); <a class="tsd-kind-property" href="client.DeepClientInstance.html#handleOperation">handleOperation</a>?: ((operation: string, query?: any, value?: any, options?: any) => any); <a class="tsd-kind-property" href="client.DeepClientInstance.html#handlersSelectReturning">handlersSelectReturning</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#insertReturning">insertReturning</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#linkId">linkId</a>?: <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>; <a class="tsd-kind-property" href="client.DeepClientInstance.html#linksSelectReturning">linksSelectReturning</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#minilinks">minilinks</a>: <a href="minilinks.MinilinksResult.html" class="tsd-signature-type tsd-kind-interface">MinilinksResult</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#L">L</a>>; <a class="tsd-kind-property" href="client.DeepClientInstance.html#ml">ml</a>: <a href="minilinks.MinilinksResult.html" class="tsd-signature-type tsd-kind-interface">MinilinksResult</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#L">L</a>>; <a class="tsd-kind-property" href="client.DeepClientInstance.html#namespace">namespace</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#Query">Query</a>: NamedExoticComponent<any>; <a class="tsd-kind-property" href="client.DeepClientInstance.html#returning">returning</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#secret">secret</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#selectorsSelectReturning">selectorsSelectReturning</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#selectReturning">selectReturning</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#ssl">ssl</a>?: boolean; <a class="tsd-kind-property" href="client.DeepClientInstance.html#Subscription">Subscription</a>: NamedExoticComponent<any>; <a class="tsd-kind-property" href="client.DeepClientInstance.html#table">table</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#token">token</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#treeSelectReturning">treeSelectReturning</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#unsafe">unsafe</a>?: any; <a class="tsd-kind-property" href="client.DeepClientInstance.html#updateReturning">updateReturning</a>?: string; <a class="tsd-kind-property" href="client.DeepClientInstance.html#url">url</a>: ((target: "deeplinks" | "gql") => string); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useCan">useCan</a>: ((objectId: <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a> | <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>[], subjectId: <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a> | <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>[], actionId: <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a> | <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>[]) => { data: boolean | void; loading: boolean; refetch: (() => Promise<boolean>); }); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useDeep">useDeep</a>: (() => <a href="../classes/client.DeepClient.html" class="tsd-signature-type tsd-kind-class">DeepClient</a><<a href="minilinks.Link.html" class="tsd-signature-type tsd-kind-interface">Link</a><<a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>>>); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useDeepId">useDeepId</a>: ((start: <a href="client_types.QueryLink.html" class="tsd-signature-type tsd-kind-interface">QueryLink</a> | <a href="../types/client.DeepClientStartItem.html" class="tsd-signature-type tsd-kind-type-alias">DeepClientStartItem</a>, ...path: <a href="../types/client.DeepClientPathItem.html" class="tsd-signature-type tsd-kind-type-alias">DeepClientPathItem</a>[]) => { data: <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>; error?: any; loading: boolean; }); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useDeepQuery">useDeepQuery</a>: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#useDeepQuery.__type-20.__type-21.Table-1">Table</a>, <a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#useDeepQuery.__type-20.__type-21.LL">LL</a>>(query: <a href="../types/client.Exp.html" class="tsd-signature-type tsd-kind-type-alias">Exp</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepQuery.html#useDeepQuery.Table">Table</a>>, options?: <a href="../types/client.Options.html" class="tsd-signature-type tsd-kind-type-alias">Options</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepQuery.html#useDeepQuery.Table">Table</a>>) => { data?: <a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepQuery.html#useDeepQuery.LL">LL</a>[]; error?: any; loading: boolean; refetch?: (() => Promise<any>); }); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useDeepSubscription">useDeepSubscription</a>: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#useDeepSubscription.__type-25.__type-26.Table-2">Table</a>, <a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#useDeepSubscription.__type-25.__type-26.LL-1">LL</a>>(query: <a href="../types/client.Exp.html" class="tsd-signature-type tsd-kind-type-alias">Exp</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepSubscription.html#useDeepSubscription.Table">Table</a>>, options?: <a href="../types/client.Options.html" class="tsd-signature-type tsd-kind-type-alias">Options</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepSubscription.html#useDeepSubscription.Table">Table</a>>) => <a href="client.UseDeepSubscriptionResult.html" class="tsd-signature-type tsd-kind-interface">UseDeepSubscriptionResult</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepSubscription.html#useDeepSubscription.LL">LL</a>>); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useId">useId</a>: ((start: <a href="client_types.QueryLink.html" class="tsd-signature-type tsd-kind-interface">QueryLink</a> | <a href="../types/client.DeepClientStartItem.html" class="tsd-signature-type tsd-kind-type-alias">DeepClientStartItem</a>, ...path: <a href="../types/client.DeepClientPathItem.html" class="tsd-signature-type tsd-kind-type-alias">DeepClientPathItem</a>[]) => { data: <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>; error?: any; loading: boolean; }); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useLink">useLink</a>: ((link: <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a> | <a href="minilinks.Link.html" class="tsd-signature-type tsd-kind-interface">Link</a><<a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>>) => <a href="../classes/minilinks.MinilinksLink.html" class="tsd-signature-type tsd-kind-class">MinilinksLink</a><<a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>>); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useLinks">useLinks</a>: ((...links: (<a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a> | <a href="minilinks.Link.html" class="tsd-signature-type tsd-kind-interface">Link</a><<a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>>)[]) => <a href="../classes/minilinks.MinilinksLink.html" class="tsd-signature-type tsd-kind-class">MinilinksLink</a><<a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>>[]); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useLocalId">useLocalId</a>: ((start: <a href="client_types.QueryLink.html" class="tsd-signature-type tsd-kind-interface">QueryLink</a> | <a href="../types/client.DeepClientStartItem.html" class="tsd-signature-type tsd-kind-type-alias">DeepClientStartItem</a>, ...path: <a href="../types/client.DeepClientPathItem.html" class="tsd-signature-type tsd-kind-type-alias">DeepClientPathItem</a>[]) => void | <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useLocalQuery">useLocalQuery</a>: ((query: <a href="../types/client.Exp.html" class="tsd-signature-type tsd-kind-type-alias">Exp</a><"links">, options?: <a href="minilinks.MinilinksQueryOptions.html" class="tsd-signature-type tsd-kind-interface">MinilinksQueryOptions</a><<a href="../types/minilinks.MinilinksQueryOptionAggregate.html" class="tsd-signature-type tsd-kind-type-alias">MinilinksQueryOptionAggregate</a>>) => <a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#L">L</a>[]); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useLocalSubscription">useLocalSubscription</a>: ((query: <a href="../types/client.Exp.html" class="tsd-signature-type tsd-kind-type-alias">Exp</a><"links">, options?: <a href="minilinks.MinilinksQueryOptions.html" class="tsd-signature-type tsd-kind-interface">MinilinksQueryOptions</a><<a href="../types/minilinks.MinilinksQueryOptionAggregate.html" class="tsd-signature-type tsd-kind-type-alias">MinilinksQueryOptionAggregate</a>>) => <a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#L">L</a>[]); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useMinilinksId">useMinilinksId</a>: ((start: <a href="client_types.QueryLink.html" class="tsd-signature-type tsd-kind-interface">QueryLink</a> | <a href="../types/client.DeepClientStartItem.html" class="tsd-signature-type tsd-kind-type-alias">DeepClientStartItem</a>, ...path: <a href="../types/client.DeepClientPathItem.html" class="tsd-signature-type tsd-kind-type-alias">DeepClientPathItem</a>[]) => void | <a href="../types/minilinks.Id.html" class="tsd-signature-type tsd-kind-type-alias">Id</a>); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useMinilinksQuery">useMinilinksQuery</a>: ((query: <a href="../types/client.Exp.html" class="tsd-signature-type tsd-kind-type-alias">Exp</a><"links">, options?: <a href="minilinks.MinilinksQueryOptions.html" class="tsd-signature-type tsd-kind-interface">MinilinksQueryOptions</a><<a href="../types/minilinks.MinilinksQueryOptionAggregate.html" class="tsd-signature-type tsd-kind-type-alias">MinilinksQueryOptionAggregate</a>>) => <a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#L">L</a>[]); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useMinilinksSubscription">useMinilinksSubscription</a>: ((query: <a href="../types/client.Exp.html" class="tsd-signature-type tsd-kind-type-alias">Exp</a><"links">, options?: <a href="minilinks.MinilinksQueryOptions.html" class="tsd-signature-type tsd-kind-interface">MinilinksQueryOptions</a><<a href="../types/minilinks.MinilinksQueryOptionAggregate.html" class="tsd-signature-type tsd-kind-type-alias">MinilinksQueryOptionAggregate</a>>) => <a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#L">L</a>[]); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useQuery">useQuery</a>: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#useQuery.__type-46.__type-47.Table-3">Table</a>, <a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#useQuery.__type-46.__type-47.LL-2">LL</a>>(query: <a href="../types/client.Exp.html" class="tsd-signature-type tsd-kind-type-alias">Exp</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepQuery.html#useDeepQuery.Table">Table</a>>, options?: <a href="../types/client.Options.html" class="tsd-signature-type tsd-kind-type-alias">Options</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepQuery.html#useDeepQuery.Table">Table</a>>) => { data?: <a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepQuery.html#useDeepQuery.LL">LL</a>[]; error?: any; loading: boolean; refetch?: (() => Promise<any>); }); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useSearch">useSearch</a>: ((value: string, options?: <a href="client.DeepSearchOptions.html" class="tsd-signature-type tsd-kind-interface">DeepSearchOptions</a>) => any); <a class="tsd-kind-property" href="client.DeepClientInstance.html#useSubscription">useSubscription</a>: (<<a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#useSubscription.__type-53.__type-54.Table-4">Table</a>, <a class="tsd-signature-type tsd-kind-type-parameter" href="client.DeepClientInstance.html#useSubscription.__type-53.__type-54.LL-3">LL</a>>(query: <a href="../types/client.Exp.html" class="tsd-signature-type tsd-kind-type-alias">Exp</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepSubscription.html#useDeepSubscription.Table">Table</a>>, options?: <a href="../types/client.Options.html" class="tsd-signature-type tsd-kind-type-alias">Options</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepSubscription.html#useDeepSubscription.Table">Table</a>>) => <a href="client.UseDeepSubscriptionResult.html" class="tsd-signature-type tsd-kind-interface">UseDeepSubscriptionResult</a><<a class="tsd-signature-type tsd-kind-type-parameter" href="../functions/client.useDeepSubscription.html#useDeepSubscription.LL">LL</a>>); <a class="tsd-kind-property" href="client.DeepClientInstance.html#valuesSelectReturning">valuesSelectReturning</a><span cla