Function deleteChildById

deleteChildById<DocumentType>(context, collectionName, id, rootObjectId, options?): Promise<DocumentType | undefined>
Delete a child object using its _id field and its parents _id.
Type Parameters
- DocumentType extends DocumentWithId
Parameters
- context: Context
  
  the context object
- collectionName: string
  
  the name of the collection
- id: string
  
  the child object to remove
- rootObjectId: string
  
  the parent object id
- options: {
  condition?: CompositeCondition;
  } = {}
  
  options to change behaviour of DynamoDB
  - Optional condition?: CompositeCondition
    
    a condition expression blocking the delete operation
Returns Promise<DocumentType | undefined>
the deleted object (as stored in the database), or undefined if not found

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

Generated using TypeDoc