Type Parameters

Constructors

Properties

_updating: boolean = false
byFrom: {
    [id: Id]: Links<Id, L>;
} = {}
byId: {
    [id: Id]: L;
} = {}
byTo: {
    [id: Id]: Links<Id, L>;
} = {}
byType: {
    [id: Id]: Links<Id, L>;
} = {}
deep?: DeepClient<Link<Id>>
emitter: EventEmitter<DefaultEventMap>
links: Links<Id, L> = ...
options: MGO
toPlain: (<Ref>(link: any) => LinkPlain<Ref>) = toPlain
types: {
    [id: Id]: Links<Id, L>;
} = {}
useMinilinksApply: (<L>(ml: any, name: string, data?: MinilinksApplyInput | Links<Id, L>) => {
    anomalies?: MinilinkError[];
    data: L[];
    errors?: MinilinkError[];
    plainLinks: L[];
}) = useMinilinksApply
useMinilinksFilter: (<L, R>(ml: any, filter: ((currentLink: L, oldLink: L, newLink: L) => boolean), results: ((l?: L, ml?: any, oldLink?: L, newLink?: L) => R), interval?: number) => R) = useMinilinksFilter
useMinilinksHandle: (<L>(ml: any, handler: ((event: any, oldLink: any, newLink: any) => any)) => void) = useMinilinksHandle
useMinilinksId: ((ml: any, start: QueryLink | DeepClientStartItem, ...path: DeepClientPathItem[]) => Id | void) = useMinilinksId
useMinilinksQuery: (<L>(ml: any, query: Id | QueryLink, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => any) = useMinilinksQuery

Type declaration

useMinilinksSubscription: (<L>(ml: any, query: Id | QueryLink, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => any) = useMinilinksSubscription

Type declaration

virtual: {
    [id: Id]: Id;
} = {}
virtualCounter: number = -1
virtualInverted: {
    [id: Id]: Id;
} = {}

Methods

  • Parameters

    • linkOrLinks: any
    • applyOptions: any
    • plainLinksArray: any
    • returnLinksPathsById: any

    Returns void

  • Find id of a link from minilinks by link name or id and contain values (names) as path items

    Parameters

    Returns Id

    A promise that resolves to the id of the link

    const corePackageLinkId = deep.minilinks.id("@deep-foundation/core")
    
    const userTypeLinkId = deep.minilinks.id("@deep-foundation/core", "User")
    
    const myLinkId = deep.minilinks.id(deep.linkId, 'My Link Name', 'My Nested Link Name')
    
    const adminLinkId = deep.minilinks.id("deep", "admin")
    
  • Returns a name of a link input that is located in a value of a contain link pointing to the link input according to links stored in minilinks

    Parameters

    Returns string

    const userTypeLinkId = await deep.id("@deep-foundation/core", "User");
    const userTypeLinkName = deep.minilinks.name(userTypeLinkId);

    Note: "@deep-foundation/core" package, "User" link, Contain link pointing from "@deep-foundation/core" to "User" must be in minilinks

  • Returns a symbol of a link input that is located in a value of a contain link pointing to the link input according to links stored in minilinks

    Parameters

    Returns string

    const userTypeLinkId = await deep.id("@deep-foundation/core", "User");
    const userTypeLinkName = deep.minilinks.name(userTypeLinkId);

    Note: "@deep-foundation/core" package, "User" link, Contain link pointing from "@deep-foundation/core" to "User" must be in minilinks