Skip to content

introduce function getBib for retrieving a formatted reference for each item if requested via options.include=bib. #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
peterstadler wants to merge 1 commit into
base: master
Choose a base branch
from
Open

introduce function getBib for retrieving a formatted reference for each item if requested via options.include=bib. #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/response.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,17 @@ class ApiResponse {
return null;
}

/**
* Bib available in the response if requested via `options.include=bib`. Specialised classes provide extracted meta data depending on context.
* @return {object}
*/
getBib() {
if('bib' in this.raw) {
return this.raw.bib;
}
return null;
}

/**
* Value of the "Last-Modified-Version" header in response if present. Specialised classes provide
version depending on context
Expand Down Expand Up @@ -144,6 +155,14 @@ module:zotero-api-client~MultiReadResponse#getData}
return this.raw.map(r => 'meta' in r && r.meta || null);
}

/**
* @return {Array} a list of formatted references (if requested via `options.include=bib`), indexes of the array match indexes of entities in {@link
module:zotero-api-client~MultiReadResponse#getData}
*/
getBib() {
return this.raw.map(r => 'bib' in r && r.bib || null);
}

/**
* @return {?number} Total number of results
*/
Expand Down