Class CollectionDocumentTuples

Index

Constructors

Accessors

depth isRoot isSubcollection path tuples

Methods

moveDown moveUp fromPath

Constructors

constructor

new CollectionDocumentTuples(
    tuples?:
        | CollectionDocumentTuples
        | CollectionDocumentTuple<IFirestormModel>
        | CollectionDocumentTuple<IFirestormModel>[],
): CollectionDocumentTuples
Parameters
- Optionaltuples:
      | CollectionDocumentTuples
      | CollectionDocumentTuple<IFirestormModel>
      | CollectionDocumentTuple<IFirestormModel>[]
Returns CollectionDocumentTuples
- Defined in packages/firestorm/src/core/collection-document.ts:53

Accessors

depth

get depth(): number
Returns number
- Defined in packages/firestorm/src/core/collection-document.ts:74

isRoot

get isRoot(): boolean
Returns boolean
- Defined in packages/firestorm/src/core/collection-document.ts:78

isSubcollection

get isSubcollection(): boolean
Returns boolean
- Defined in packages/firestorm/src/core/collection-document.ts:82

path

get path(): string
Returns string
- Defined in packages/firestorm/src/core/collection-document.ts:70

tuples

get tuples(): CollectionDocumentTuple<IFirestormModel>[]
Returns CollectionDocumentTuple<IFirestormModel>[]
- Defined in packages/firestorm/src/core/collection-document.ts:66

Methods

moveDown

moveDown<T extends IFirestormModel>(
tuple: CollectionDocumentTuple<T>,
): CollectionDocumentTuples
Type Parameters
- T extends IFirestormModel
Parameters
- tuple: CollectionDocumentTuple<T>
Returns CollectionDocumentTuples
- Defined in packages/firestorm/src/core/collection-document.ts:90

moveUp

moveUp(): CollectionDocumentTuples
Returns CollectionDocumentTuples
- Defined in packages/firestorm/src/core/collection-document.ts:86

`Static`fromPath

fromPath(path: string): CollectionDocumentTuples
Parameters
- path: string
Returns CollectionDocumentTuples
- Defined in packages/firestorm/src/core/collection-document.ts:94