Skip to content

feat: added addParams support for entry class #134

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

Merged
vkalta merged 3 commits into from
Feb 5, 2025
Merged

feat: added addParams support for entry class #134

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6de2efe
feat: added addParams support for entry class
Feb 3, 2025
88f0be6
fix: fixed docstrings
Feb 4, 2025
26c0510
fix: minor fix on docstrings
Feb 4, 2025
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
22 changes: 21 additions & 1 deletion src/lib/entry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ export class Entry {
private _urlPath: string;
protected _variants: string;
_queryParams: { [key: string]: string | number | string[] } = {};

constructor(client: AxiosInstance, contentTypeUid: string, entryUid: string) {
this._client = client;
this._contentTypeUid = contentTypeUid;
Expand Down Expand Up @@ -195,4 +194,25 @@ export class Entry {

return response;
}

/**
* @method addParams
* @memberof BaseQuery
* @description Adds a query parameter to the query.
* @example
* import contentstack from '@contentstack/delivery-sdk'
*
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
* const query = stack.contentType("contentTypeUid").entry().query();
Comment thread
vkalta marked this conversation as resolved.
Outdated
* const result = await query.addParams({"key": "value"}).find()
* // OR
* const asset = await stack.asset().addParams({"key": "value"}).find()
*
* @returns {Entry}
*/
addParams(paramObj: { [key: string]: string | number | string[] }): Entry {
this._queryParams = { ...this._queryParams, ...paramObj };

return this;
}
}