@pyric/cli 0.1.0-alpha.20 → 0.1.0-alpha.22

package/dist/serve/site-ui/docs/pyric-firestore-lite-reference-api.md

@@ -0,0 +1,1240 @@
+<!-- Generated from published package declarations via TypeDoc. Rendered by the api-reference content loader. -->
+
+## Classes
+
+<a id="pyricdeferredapierror"></a>
+
+### PyricDeferredApiError
+
+The error thrown by every deferred Firebase entry. Carries the subpath and
+the symbol that was touched so tooling can group these without parsing the
+message.
+
+#### Extends
+
+- `Error`
+
+#### Constructors
+
+<a id="constructor"></a>
+
+##### Constructor
+
+```ts
+new PyricDeferredApiError(subpath: string, symbol: string): PyricDeferredApiError;
+```
+
+###### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `subpath` | `string` |
+| `symbol` | `string` |
+
+###### Returns
+
+[`PyricDeferredApiError`](#pyricdeferredapierror)
+
+###### Overrides
+
+```ts
+Error.constructor
+```
+
+#### Properties
+
+| Property | Modifier | Type | Default value | Description | Overrides |
+| :------ | :------ | :------ | :------ | :------ | :------ |
+| <a id="name"></a> `name` | `readonly` | `"PyricDeferredApiError"` | `"PyricDeferredApiError"` | - | `Error.name` |
+| <a id="subpath"></a> `subpath` | `readonly` | `string` | `undefined` | The Firebase subpath, without the `firebase/` prefix (e.g. `functions`). | - |
+| <a id="symbol"></a> `symbol` | `readonly` | `string` | `undefined` | The exported symbol whose use triggered this error (e.g. `getFunctions`). | - |
+
+## Type Aliases
+
+<a id="addprefixtokeys"></a>
+
+### AddPrefixToKeys
+
+```ts
+type AddPrefixToKeys = DeferredApi;
+```
+
+***
+
+<a id="aggregatefield"></a>
+
+### AggregateField
+
+```ts
+type AggregateField = DeferredApi;
+```
+
+***
+
+<a id="aggregatefieldtype"></a>
+
+### AggregateFieldType
+
+```ts
+type AggregateFieldType = DeferredApi;
+```
+
+***
+
+<a id="aggregatequerysnapshot"></a>
+
+### AggregateQuerySnapshot
+
+```ts
+type AggregateQuerySnapshot = DeferredApi;
+```
+
+***
+
+<a id="aggregatespec"></a>
+
+### AggregateSpec
+
+```ts
+type AggregateSpec = DeferredApi;
+```
+
+***
+
+<a id="aggregatespecdata"></a>
+
+### AggregateSpecData
+
+```ts
+type AggregateSpecData = DeferredApi;
+```
+
+***
+
+<a id="aggregatetype"></a>
+
+### AggregateType
+
+```ts
+type AggregateType = DeferredApi;
+```
+
+***
+
+<a id="bytes"></a>
+
+### Bytes
+
+```ts
+type Bytes = DeferredApi;
+```
+
+***
+
+<a id="childupdatefields"></a>
+
+### ChildUpdateFields
+
+```ts
+type ChildUpdateFields = DeferredApi;
+```
+
+***
+
+<a id="collectionreference"></a>
+
+### CollectionReference
+
+```ts
+type CollectionReference = DeferredApi;
+```
+
+***
+
+<a id="documentdata"></a>
+
+### DocumentData
+
+```ts
+type DocumentData = DeferredApi;
+```
+
+***
+
+<a id="documentreference"></a>
+
+### DocumentReference
+
+```ts
+type DocumentReference = DeferredApi;
+```
+
+***
+
+<a id="documentsnapshot"></a>
+
+### DocumentSnapshot
+
+```ts
+type DocumentSnapshot = DeferredApi;
+```
+
+***
+
+<a id="emulatormocktokenoptions"></a>
+
+### EmulatorMockTokenOptions
+
+```ts
+type EmulatorMockTokenOptions = DeferredApi;
+```
+
+***
+
+<a id="fieldpath"></a>
+
+### FieldPath
+
+```ts
+type FieldPath = DeferredApi;
+```
+
+***
+
+<a id="fieldvalue"></a>
+
+### FieldValue
+
+```ts
+type FieldValue = DeferredApi;
+```
+
+***
+
+<a id="firestore"></a>
+
+### Firestore
+
+```ts
+type Firestore = DeferredApi;
+```
+
+***
+
+<a id="firestoredataconverter"></a>
+
+### FirestoreDataConverter
+
+```ts
+type FirestoreDataConverter = DeferredApi;
+```
+
+***
+
+<a id="firestoreerror"></a>
+
+### FirestoreError
+
+```ts
+type FirestoreError = DeferredApi;
+```
+
+***
+
+<a id="firestoreerrorcode"></a>
+
+### FirestoreErrorCode
+
+```ts
+type FirestoreErrorCode = DeferredApi;
+```
+
+***
+
+<a id="geopoint"></a>
+
+### GeoPoint
+
+```ts
+type GeoPoint = DeferredApi;
+```
+
+***
+
+<a id="loglevel"></a>
+
+### LogLevel
+
+```ts
+type LogLevel = DeferredApi;
+```
+
+***
+
+<a id="nestedupdatefields"></a>
+
+### NestedUpdateFields
+
+```ts
+type NestedUpdateFields = DeferredApi;
+```
+
+***
+
+<a id="orderbydirection"></a>
+
+### OrderByDirection
+
+```ts
+type OrderByDirection = DeferredApi;
+```
+
+***
+
+<a id="partialwithfieldvalue"></a>
+
+### PartialWithFieldValue
+
+```ts
+type PartialWithFieldValue = DeferredApi;
+```
+
+***
+
+<a id="primitive"></a>
+
+### Primitive
+
+```ts
+type Primitive = DeferredApi;
+```
+
+***
+
+<a id="query"></a>
+
+### Query
+
+```ts
+type Query = DeferredApi;
+```
+
+***
+
+<a id="querycompositefilterconstraint"></a>
+
+### QueryCompositeFilterConstraint
+
+```ts
+type QueryCompositeFilterConstraint = DeferredApi;
+```
+
+***
+
+<a id="queryconstraint"></a>
+
+### QueryConstraint
+
+```ts
+type QueryConstraint = DeferredApi;
+```
+
+***
+
+<a id="queryconstrainttype"></a>
+
+### QueryConstraintType
+
+```ts
+type QueryConstraintType = DeferredApi;
+```
+
+***
+
+<a id="querydocumentsnapshot"></a>
+
+### QueryDocumentSnapshot
+
+```ts
+type QueryDocumentSnapshot = DeferredApi;
+```
+
+***
+
+<a id="queryendatconstraint"></a>
+
+### QueryEndAtConstraint
+
+```ts
+type QueryEndAtConstraint = DeferredApi;
+```
+
+***
+
+<a id="queryfieldfilterconstraint"></a>
+
+### QueryFieldFilterConstraint
+
+```ts
+type QueryFieldFilterConstraint = DeferredApi;
+```
+
+***
+
+<a id="queryfilterconstraint"></a>
+
+### QueryFilterConstraint
+
+```ts
+type QueryFilterConstraint = DeferredApi;
+```
+
+***
+
+<a id="querylimitconstraint"></a>
+
+### QueryLimitConstraint
+
+```ts
+type QueryLimitConstraint = DeferredApi;
+```
+
+***
+
+<a id="querynonfilterconstraint"></a>
+
+### QueryNonFilterConstraint
+
+```ts
+type QueryNonFilterConstraint = DeferredApi;
+```
+
+***
+
+<a id="queryorderbyconstraint"></a>
+
+### QueryOrderByConstraint
+
+```ts
+type QueryOrderByConstraint = DeferredApi;
+```
+
+***
+
+<a id="querysnapshot"></a>
+
+### QuerySnapshot
+
+```ts
+type QuerySnapshot = DeferredApi;
+```
+
+***
+
+<a id="querystartatconstraint"></a>
+
+### QueryStartAtConstraint
+
+```ts
+type QueryStartAtConstraint = DeferredApi;
+```
+
+***
+
+<a id="setoptions"></a>
+
+### SetOptions
+
+```ts
+type SetOptions = DeferredApi;
+```
+
+***
+
+<a id="settings"></a>
+
+### Settings
+
+```ts
+type Settings = DeferredApi;
+```
+
+***
+
+<a id="timestamp"></a>
+
+### Timestamp
+
+```ts
+type Timestamp = DeferredApi;
+```
+
+***
+
+<a id="transaction"></a>
+
+### Transaction
+
+```ts
+type Transaction = DeferredApi;
+```
+
+***
+
+<a id="transactionoptions"></a>
+
+### TransactionOptions
+
+```ts
+type TransactionOptions = DeferredApi;
+```
+
+***
+
+<a id="uniontointersection"></a>
+
+### UnionToIntersection
+
+```ts
+type UnionToIntersection = DeferredApi;
+```
+
+***
+
+<a id="updatedata"></a>
+
+### UpdateData
+
+```ts
+type UpdateData = DeferredApi;
+```
+
+***
+
+<a id="vectorvalue"></a>
+
+### VectorValue
+
+```ts
+type VectorValue = DeferredApi;
+```
+
+***
+
+<a id="wherefilterop"></a>
+
+### WhereFilterOp
+
+```ts
+type WhereFilterOp = DeferredApi;
+```
+
+***
+
+<a id="withfieldvalue"></a>
+
+### WithFieldValue
+
+```ts
+type WithFieldValue = DeferredApi;
+```
+
+***
+
+<a id="writebatch"></a>
+
+### WriteBatch
+
+```ts
+type WriteBatch = DeferredApi;
+```
+
+## Variables
+
+<a id="adddoc"></a>
+
+### addDoc
+
+```ts
+const addDoc: DeferredApi;
+```
+
+***
+
+<a id="aggregatefield-1"></a>
+
+### AggregateField
+
+```ts
+const AggregateField: DeferredApi;
+```
+
+***
+
+<a id="aggregatefieldequal"></a>
+
+### aggregateFieldEqual
+
+```ts
+const aggregateFieldEqual: DeferredApi;
+```
+
+***
+
+<a id="aggregatequerysnapshot-1"></a>
+
+### AggregateQuerySnapshot
+
+```ts
+const AggregateQuerySnapshot: DeferredApi;
+```
+
+***
+
+<a id="aggregatequerysnapshotequal"></a>
+
+### aggregateQuerySnapshotEqual
+
+```ts
+const aggregateQuerySnapshotEqual: DeferredApi;
+```
+
+***
+
+<a id="and"></a>
+
+### and
+
+```ts
+const and: DeferredApi;
+```
+
+***
+
+<a id="arrayremove"></a>
+
+### arrayRemove
+
+```ts
+const arrayRemove: DeferredApi;
+```
+
+***
+
+<a id="arrayunion"></a>
+
+### arrayUnion
+
+```ts
+const arrayUnion: DeferredApi;
+```
+
+***
+
+<a id="average"></a>
+
+### average
+
+```ts
+const average: DeferredApi;
+```
+
+***
+
+<a id="bytes-1"></a>
+
+### Bytes
+
+```ts
+const Bytes: DeferredApi;
+```
+
+***
+
+<a id="collection"></a>
+
+### collection
+
+```ts
+const collection: DeferredApi;
+```
+
+***
+
+<a id="collectiongroup"></a>
+
+### collectionGroup
+
+```ts
+const collectionGroup: DeferredApi;
+```
+
+***
+
+<a id="collectionreference-1"></a>
+
+### CollectionReference
+
+```ts
+const CollectionReference: DeferredApi;
+```
+
+***
+
+<a id="connectfirestoreemulator"></a>
+
+### connectFirestoreEmulator
+
+```ts
+const connectFirestoreEmulator: DeferredApi;
+```
+
+***
+
+<a id="count"></a>
+
+### count
+
+```ts
+const count: DeferredApi;
+```
+
+***
+
+<a id="deletedoc"></a>
+
+### deleteDoc
+
+```ts
+const deleteDoc: DeferredApi;
+```
+
+***
+
+<a id="deletefield"></a>
+
+### deleteField
+
+```ts
+const deleteField: DeferredApi;
+```
+
+***
+
+<a id="doc"></a>
+
+### doc
+
+```ts
+const doc: DeferredApi;
+```
+
+***
+
+<a id="documentid"></a>
+
+### documentId
+
+```ts
+const documentId: DeferredApi;
+```
+
+***
+
+<a id="documentreference-1"></a>
+
+### DocumentReference
+
+```ts
+const DocumentReference: DeferredApi;
+```
+
+***
+
+<a id="documentsnapshot-1"></a>
+
+### DocumentSnapshot
+
+```ts
+const DocumentSnapshot: DeferredApi;
+```
+
+***
+
+<a id="endat"></a>
+
+### endAt
+
+```ts
+const endAt: DeferredApi;
+```
+
+***
+
+<a id="endbefore"></a>
+
+### endBefore
+
+```ts
+const endBefore: DeferredApi;
+```
+
+***
+
+<a id="fieldpath-1"></a>
+
+### FieldPath
+
+```ts
+const FieldPath: DeferredApi;
+```
+
+***
+
+<a id="fieldvalue-1"></a>
+
+### FieldValue
+
+```ts
+const FieldValue: DeferredApi;
+```
+
+***
+
+<a id="firestore-1"></a>
+
+### Firestore
+
+```ts
+const Firestore: DeferredApi;
+```
+
+***
+
+<a id="firestoreerror-1"></a>
+
+### FirestoreError
+
+```ts
+const FirestoreError: DeferredApi;
+```
+
+***
+
+<a id="geopoint-1"></a>
+
+### GeoPoint
+
+```ts
+const GeoPoint: DeferredApi;
+```
+
+***
+
+<a id="getaggregate"></a>
+
+### getAggregate
+
+```ts
+const getAggregate: DeferredApi;
+```
+
+***
+
+<a id="getcount"></a>
+
+### getCount
+
+```ts
+const getCount: DeferredApi;
+```
+
+***
+
+<a id="getdoc"></a>
+
+### getDoc
+
+```ts
+const getDoc: DeferredApi;
+```
+
+***
+
+<a id="getdocs"></a>
+
+### getDocs
+
+```ts
+const getDocs: DeferredApi;
+```
+
+***
+
+<a id="getfirestore"></a>
+
+### getFirestore
+
+```ts
+const getFirestore: DeferredApi;
+```
+
+***
+
+<a id="increment"></a>
+
+### increment
+
+```ts
+const increment: DeferredApi;
+```
+
+***
+
+<a id="initializefirestore"></a>
+
+### initializeFirestore
+
+```ts
+const initializeFirestore: DeferredApi;
+```
+
+***
+
+<a id="limit"></a>
+
+### limit
+
+```ts
+const limit: DeferredApi;
+```
+
+***
+
+<a id="limittolast"></a>
+
+### limitToLast
+
+```ts
+const limitToLast: DeferredApi;
+```
+
+***
+
+<a id="or"></a>
+
+### or
+
+```ts
+const or: DeferredApi;
+```
+
+***
+
+<a id="orderby"></a>
+
+### orderBy
+
+```ts
+const orderBy: DeferredApi;
+```
+
+***
+
+<a id="query-1"></a>
+
+### query
+
+```ts
+const query: DeferredApi;
+```
+
+***
+
+<a id="query-2"></a>
+
+### Query
+
+```ts
+const Query: DeferredApi;
+```
+
+***
+
+<a id="querycompositefilterconstraint-1"></a>
+
+### QueryCompositeFilterConstraint
+
+```ts
+const QueryCompositeFilterConstraint: DeferredApi;
+```
+
+***
+
+<a id="queryconstraint-1"></a>
+
+### QueryConstraint
+
+```ts
+const QueryConstraint: DeferredApi;
+```
+
+***
+
+<a id="querydocumentsnapshot-1"></a>
+
+### QueryDocumentSnapshot
+
+```ts
+const QueryDocumentSnapshot: DeferredApi;
+```
+
+***
+
+<a id="queryendatconstraint-1"></a>
+
+### QueryEndAtConstraint
+
+```ts
+const QueryEndAtConstraint: DeferredApi;
+```
+
+***
+
+<a id="queryequal"></a>
+
+### queryEqual
+
+```ts
+const queryEqual: DeferredApi;
+```
+
+***
+
+<a id="queryfieldfilterconstraint-1"></a>
+
+### QueryFieldFilterConstraint
+
+```ts
+const QueryFieldFilterConstraint: DeferredApi;
+```
+
+***
+
+<a id="querylimitconstraint-1"></a>
+
+### QueryLimitConstraint
+
+```ts
+const QueryLimitConstraint: DeferredApi;
+```
+
+***
+
+<a id="queryorderbyconstraint-1"></a>
+
+### QueryOrderByConstraint
+
+```ts
+const QueryOrderByConstraint: DeferredApi;
+```
+
+***
+
+<a id="querysnapshot-1"></a>
+
+### QuerySnapshot
+
+```ts
+const QuerySnapshot: DeferredApi;
+```
+
+***
+
+<a id="querystartatconstraint-1"></a>
+
+### QueryStartAtConstraint
+
+```ts
+const QueryStartAtConstraint: DeferredApi;
+```
+
+***
+
+<a id="refequal"></a>
+
+### refEqual
+
+```ts
+const refEqual: DeferredApi;
+```
+
+***
+
+<a id="runtransaction"></a>
+
+### runTransaction
+
+```ts
+const runTransaction: DeferredApi;
+```
+
+***
+
+<a id="servertimestamp"></a>
+
+### serverTimestamp
+
+```ts
+const serverTimestamp: DeferredApi;
+```
+
+***
+
+<a id="setdoc"></a>
+
+### setDoc
+
+```ts
+const setDoc: DeferredApi;
+```
+
+***
+
+<a id="setloglevel"></a>
+
+### setLogLevel
+
+```ts
+const setLogLevel: DeferredApi;
+```
+
+***
+
+<a id="snapshotequal"></a>
+
+### snapshotEqual
+
+```ts
+const snapshotEqual: DeferredApi;
+```
+
+***
+
+<a id="startafter"></a>
+
+### startAfter
+
+```ts
+const startAfter: DeferredApi;
+```
+
+***
+
+<a id="startat"></a>
+
+### startAt
+
+```ts
+const startAt: DeferredApi;
+```
+
+***
+
+<a id="sum"></a>
+
+### sum
+
+```ts
+const sum: DeferredApi;
+```
+
+***
+
+<a id="terminate"></a>
+
+### terminate
+
+```ts
+const terminate: DeferredApi;
+```
+
+***
+
+<a id="timestamp-1"></a>
+
+### Timestamp
+
+```ts
+const Timestamp: DeferredApi;
+```
+
+***
+
+<a id="transaction-1"></a>
+
+### Transaction
+
+```ts
+const Transaction: DeferredApi;
+```
+
+***
+
+<a id="updatedoc"></a>
+
+### updateDoc
+
+```ts
+const updateDoc: DeferredApi;
+```
+
+***
+
+<a id="vector"></a>
+
+### vector
+
+```ts
+const vector: DeferredApi;
+```
+
+***
+
+<a id="vectorvalue-1"></a>
+
+### VectorValue
+
+```ts
+const VectorValue: DeferredApi;
+```
+
+***
+
+<a id="where"></a>
+
+### where
+
+```ts
+const where: DeferredApi;
+```
+
+***
+
+<a id="writebatch-1"></a>
+
+### writeBatch
+
+```ts
+const writeBatch: DeferredApi;
+```
+
+***
+
+<a id="writebatch-2"></a>
+
+### WriteBatch
+
+```ts
+const WriteBatch: DeferredApi;
+```