Home Reference Source Test Repository 
import Document from 'cofferdam/src/document.js'
public class | source

Document

Method Summary

Public Methods
public

all(collection: *, feedOptions: *): *

public

create(collection: *, doc: *, requestOptions: {}): *

public

find(collection: *, query: *, feedOptions: *): *

public

findById(collection: *, id: *, options: {}): *

public

first(collection: *, query: *): *

public

get(documentLink: *, requestOptions: {}): *

public

last(collection: *, query: *): *

public

one(collection: *, query: *, options: {"allowMultiple": boolean}): *

public

remove(documentLink: *, options: {}): *

public

removeById(collection: *, id: *): *

public

update(documentLink: *, doc: *, options: {}): *

public

upsert(collection: *, doc: *, options: {}): *

Public Methods

public all(collection: *, feedOptions: *): * source

Params:

NameTypeAttributeDescription
collection *
feedOptions *
  • optional
  • default: options

Return:

*

public create(collection: *, doc: *, requestOptions: {}): * source

Params:

NameTypeAttributeDescription
collection *
doc *
requestOptions {}
  • optional
  • default: {}

Return:

*

public find(collection: *, query: *, feedOptions: *): * source

Params:

NameTypeAttributeDescription
collection *
query *
feedOptions *
  • optional
  • default: options

Return:

*

public findById(collection: *, id: *, options: {}): * source

Params:

NameTypeAttributeDescription
collection *
id *
options {}
  • optional
  • default: {}

Return:

*

public first(collection: *, query: *): * source

Params:

NameTypeAttributeDescription
collection *
query *

Return:

*

public get(documentLink: *, requestOptions: {}): * source

Params:

NameTypeAttributeDescription
documentLink *
requestOptions {}
  • optional
  • default: {}

Return:

*

public last(collection: *, query: *): * source

Params:

NameTypeAttributeDescription
collection *
query *

Return:

*

public one(collection: *, query: *, options: {"allowMultiple": boolean}): * source

Params:

NameTypeAttributeDescription
collection *
query *
options {"allowMultiple": boolean}
  • optional
  • default: {"allowMultiple":false}

Return:

*

public remove(documentLink: *, options: {}): * source

Params:

NameTypeAttributeDescription
documentLink *
options {}
  • optional
  • default: {}

Return:

*

public removeById(collection: *, id: *): * source

Params:

NameTypeAttributeDescription
collection *
id *

Return:

*

public update(documentLink: *, doc: *, options: {}): * source

Params:

NameTypeAttributeDescription
documentLink *
doc *
options {}
  • optional
  • default: {}

Return:

*

public upsert(collection: *, doc: *, options: {}): * source

Params:

NameTypeAttributeDescription
collection *
doc *
options {}
  • optional
  • default: {}

Return:

*