Function findById

findById<DocumentType>(context, collectionName, id, options?): Promise<DocumentType | undefined>
Retrieve a top-level document by its _id field.
Type Parameters
- DocumentType extends DocumentWithId
Parameters
- context: Context
  
  the context object
- collectionName: string
  
  name of the collection to search
- id: string
  
  the _id value of the root document
- Optional options: {
  consistentRead?: boolean;
  }
  
  the the set of options for the search
  - Optional consistentRead?: boolean
    
    search with strongly consistent reads
Returns Promise<DocumentType | undefined>
the stored value, or undefined if not found

Throws
when the collection is not found in the context
- Defined in src/operations/find_by_id.ts:25

Generated using TypeDoc