Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Document<id, parent>

Type Parameters

Hierarchy

  • Document

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Document<id, parent>(id: id, parent: parent): Document<id, parent>

Properties

_data

_data: { [ prop in string | number | symbol]: parent["docSchema"][prop] extends any[] ? MapField<any[any][1]> : parent["docSchema"][prop]["prototype"] }

Accessors

id

  • get id(): id

parent

  • get parent(): parent

Methods

get

  • get<k>(field: k): { [ prop in string | number | symbol]: parent["docSchema"][prop] extends any[] ? MapField<any[any][1]> : parent["docSchema"][prop]["prototype"] }[k]["value"]

  • Type Parameters

    • k extends string | number | symbol

    Parameters

    • field: k

    Returns { [ prop in string | number | symbol]: parent["docSchema"][prop] extends any[] ? MapField<any[any][1]> : parent["docSchema"][prop]["prototype"] }[k]["value"]

getAllCollections

getCollection

hasCollection

  • hasCollection(id: string | Collection<{}>): boolean

set

  • set<k>(field: k, value: { [ prop in string | number | symbol]: parent["docSchema"][prop] extends any[] ? MapField<any[any][1]> : parent["docSchema"][prop]["prototype"] }[k]["value"]): void

  • Type Parameters

    • k extends string | number | symbol

    Parameters

    • field: k
    • value: { [ prop in string | number | symbol]: parent["docSchema"][prop] extends any[] ? MapField<any[any][1]> : parent["docSchema"][prop]["prototype"] }[k]["value"]

    Returns void

setCollection

toSave

  • toSave(): { collections: { documents: ({ id: string; collections: { id: string; documents: ...[]; schema: { [k: string]: any; }; }[]; data: { [k: string]: any; }; })[]; id: string; schema: {} }[]; data: {}; id: id }

  • Returns { collections: { documents: ({ id: string; collections: { id: string; documents: ...[]; schema: { [k: string]: any; }; }[]; data: { [k: string]: any; }; })[]; id: string; schema: {} }[]; data: {}; id: id }

    • collections: { documents: ({ id: string; collections: { id: string; documents: ...[]; schema: { [k: string]: any; }; }[]; data: { [k: string]: any; }; })[]; id: string; schema: {} }[]
    • data: {}
      • [k: string]: any
    • id: id

Static fromSave

Generated using TypeDoc version 0.22.18, the 7/5/2022