Reference | firebase-firestore-lite

Hierarchy

Reference

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Reference(path: string, db: Database): Reference

- Defined in Reference.ts:38
Parameters
- path: string
- db: Database
Returns Reference

Properties

Readonly db

Readonly endpoint

endpoint: string

id

id: string

The ID of the document inside the collection

isRoot

isRoot: boolean

Whether or not this reference points to the root of the database

Readonly name

name: string

path

path: string

The path to the document relative to the database root

Accessors

isCollection

get isCollection(): boolean

- Defined in Reference.ts:73
Returns true if this reference is a collection

Returns boolean

parent

get parent(): Reference

- Defined in Reference.ts:56
Returns a reference to the parent document/collection

Returns Reference

parentCollection

get parentCollection(): Reference

- Defined in Reference.ts:62
Returns a reference to the parent collection

Returns Reference

Methods

add

add(obj: object, options?: CrudOptions): Promise<void | Reference>

- Defined in Reference.ts:117
Create a new document with a randomly generated id

Parameters
- obj: object
- Default value options: CrudOptions = {}
Returns Promise<void | Reference>

child

child(path: string): Reference

- Defined in Reference.ts:78
Returns a reference to the specified child path

Parameters
- path: string
Returns Reference

delete

delete(options?: CrudOptions): Promise<void | Reference>

- Defined in Reference.ts:135
Deletes the referenced document from the database.

Parameters
- Default value options: CrudOptions = {}
Returns Promise<void | Reference>

get

get(options?: CrudOptions): Promise<Document>

- Defined in Reference.ts:107
Returns the document of this reference.

Parameters
- Default value options: CrudOptions = {}
Returns Promise<Document>

list

list(options?: undefined | object): Promise<List>

- Defined in Reference.ts:97
Returns all documents in the collection

Parameters
- Optional options: undefined | object
Returns Promise<List>

query

query(options?: {}): Query

- Defined in Reference.ts:141
Queries the child documents/collections of this reference.

Parameters
- Default value options: {} = {}
Returns Query

set

set(obj: object, options?: CrudOptions): Promise<void | Reference>

- Defined in Reference.ts:123
Create a new document or overwrites an existing one matching this reference.

Parameters
- obj: object
- Default value options: CrudOptions = {}
Returns Promise<void | Reference>

toJSON

toJSON(): { referenceValue: string }

- Defined in Reference.ts:150
Returns { referenceValue: string }
- referenceValue: string

update

update(obj: object, options?: CrudOptions): Promise<void | Reference>

- Defined in Reference.ts:129
Updates a document while ignoring all missing fields in the provided object.

Parameters
- obj: object
- Default value options: CrudOptions = {}
Returns Promise<void | Reference>

Generated using TypeDoc