Skip to content

Collection

Extends

  • Collection

Properties

payload

payload: Collection;

The underlying payload data for this resource

Inherited from

Bkper.Collection.payload

Methods

getBooks()

getBooks(): Book[];

Returns

Book[]

All Books of this collection.

Inherited from

Bkper.Collection.getBooks

getId()

getId(): string;

Returns

string

The id of this Collection

Inherited from

Bkper.Collection.getId

getName()

getName(): string;

Returns

string

The name of this Collection

Inherited from

Bkper.Collection.getName

json()

json(): Collection;

Gets an immutable copy of the JSON payload for this resource.

Returns

Collection

An immutable copy of the json payload

Inherited from

Bkper.Collection.json

setName()

setName(name): Collection;

Sets the name of the Collection.

Parameters

ParameterType
namestring

Returns

Collection

This Collection, for chainning.

Inherited from

Bkper.Collection.setName

update()

update(): Collection;

Performs update Collection, applying pending changes.

Returns

Collection

The updated Collection object

Inherited from

Bkper.Collection.update