Skip to content

Commit 6900d56

Browse files
Vikram KaltaVikram Kalta
Vikram Kalta
authored and
Vikram Kalta
committed
fix: doc type fixes
1 parent 18c0e83 commit 6900d56

16 files changed

+110
-110
lines changed

‎src/lib/asset-query.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export class AssetQuery extends BaseQuery {
1616
* @example
1717
* import contentstack from '@contentstack/delivery-sdk'
1818
*
19-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
19+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
2020
* const result = await stack.asset().version(1).find();
2121
*/
2222
version(version: number): AssetQuery {
@@ -33,7 +33,7 @@ export class AssetQuery extends BaseQuery {
3333
* @example
3434
* import contentstack from '@contentstack/delivery-sdk'
3535
*
36-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
36+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
3737
* const result = await stack.asset().includeDimension().find();
3838
*/
3939
includeDimension(): AssetQuery {
@@ -50,7 +50,7 @@ export class AssetQuery extends BaseQuery {
5050
* @example
5151
* import contentstack from '@contentstack/delivery-sdk'
5252
*
53-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
53+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
5454
* const result = await stack.asset().includeBranch().find();
5555
*/
5656
includeBranch(): AssetQuery {
@@ -67,7 +67,7 @@ export class AssetQuery extends BaseQuery {
6767
* @example
6868
* import contentstack from '@contentstack/delivery-sdk'
6969
*
70-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
70+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
7171
* const result = await stack.asset().includeMetadata().fetch();
7272
*/
7373
includeMetadata(): AssetQuery {
@@ -84,7 +84,7 @@ export class AssetQuery extends BaseQuery {
8484
* @example
8585
* import contentstack from '@contentstack/delivery-sdk'
8686
*
87-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
87+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
8888
* const result = await stack.asset().relativeUrls().find();
8989
*/
9090
relativeUrls(): AssetQuery {
@@ -101,7 +101,7 @@ export class AssetQuery extends BaseQuery {
101101
* @example
102102
* import contentstack from '@contentstack/delivery-sdk'
103103
*
104-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
104+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
105105
* const result = await stack.asset().includeFallback().find();
106106
*/
107107
includeFallback(): AssetQuery {
@@ -118,7 +118,7 @@ export class AssetQuery extends BaseQuery {
118118
* @example
119119
* import contentstack from '@contentstack/delivery-sdk'
120120
*
121-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
121+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
122122
* const result = await stack.asset().locale('en-us').find();
123123
*/
124124
locale(locale: string): AssetQuery {
@@ -134,7 +134,7 @@ export class AssetQuery extends BaseQuery {
134134
* @example
135135
* import contentstack from '@contentstack/delivery-sdk'
136136
*
137-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
137+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
138138
* const result = await stack.asset().query().where('fieldUid', queryOperators, 'value').find();
139139
*/
140140
query() {

‎src/lib/asset.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export class Asset {
1818
* @example
1919
* import contentstack from '@contentstack/delivery-sdk'
2020
*
21-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
21+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
2222
* const result = await stack.asset('asset_uid').includeFallback().fetch();
2323
*/
2424
includeFallback(): Asset {
@@ -35,7 +35,7 @@ export class Asset {
3535
* @example
3636
* import contentstack from '@contentstack/delivery-sdk'
3737
*
38-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
38+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
3939
* const result = await stack.asset('asset_uid').includeMetadata().fetch();
4040
*/
4141
includeMetadata(): Asset {
@@ -52,7 +52,7 @@ export class Asset {
5252
* @example
5353
* import contentstack from '@contentstack/delivery-sdk'
5454
*
55-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
55+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
5656
* const result = await stack.asset('asset_uid').includeDimension().fetch();
5757
*/
5858
includeDimension(): Asset {
@@ -69,7 +69,7 @@ export class Asset {
6969
* @example
7070
* import contentstack from '@contentstack/delivery-sdk'
7171
*
72-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
72+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
7373
* const result = await stack.asset('asset_uid').includeBranch().fetch();
7474
*/
7575
includeBranch(): Asset {
@@ -86,7 +86,7 @@ export class Asset {
8686
* @example
8787
* import contentstack from '@contentstack/delivery-sdk'
8888
*
89-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
89+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
9090
* const result = await stack.asset('asset_uid').relativeUrls().fetch();
9191
*/
9292
relativeUrls(): Asset {
@@ -103,7 +103,7 @@ export class Asset {
103103
* @example
104104
* import contentstack from '@contentstack/delivery-sdk'
105105
*
106-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
106+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
107107
* const result = await stack.asset('asset_uid').version(1).fetch();
108108
*/
109109
version(version: number): Asset {
@@ -120,7 +120,7 @@ export class Asset {
120120
* @example
121121
* import contentstack from '@contentstack/delivery-sdk'
122122
*
123-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
123+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
124124
* const result = await stack.asset('asset_uid').locale('en-us').fetch();
125125
*/
126126
locale(locale: string): Asset {
@@ -137,7 +137,7 @@ export class Asset {
137137
* @example
138138
* import contentstack from '@contentstack/delivery-sdk'
139139
*
140-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
140+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
141141
* const result = await stack.asset('asset_uid').fetch();
142142
*/
143143
async fetch<T>(): Promise<T> {

‎src/lib/base-query.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export class BaseQuery extends Pagination {
1616
* @example
1717
* import contentstack from '@contentstack/delivery-sdk'
1818
*
19-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
19+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
2020
* const query = stack.contentType("contentTypeUid").entry().query();
2121
* const result = await query.includeCount().find()
2222
* // OR
@@ -37,7 +37,7 @@ export class BaseQuery extends Pagination {
3737
* @example
3838
* import contentstack from '@contentstack/delivery-sdk'
3939
*
40-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
40+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
4141
* const query = stack.contentType("contentTypeUid").entry().query();
4242
* const result = await query.orderByAscending("field_uid").find()
4343
* // OR
@@ -58,7 +58,7 @@ export class BaseQuery extends Pagination {
5858
* @example
5959
* import contentstack from '@contentstack/delivery-sdk'
6060
*
61-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
61+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
6262
* const query = stack.contentType("contentTypeUid").entry().query();
6363
* const result = await query.orderByDescending("field_uid").find()
6464
* // OR
@@ -79,7 +79,7 @@ export class BaseQuery extends Pagination {
7979
* @example
8080
* import contentstack from '@contentstack/delivery-sdk'
8181
*
82-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
82+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
8383
* const query = stack.contentType("contentTypeUid").entry().query();
8484
* const result = await query.limit("limit_value").find()
8585
* // OR
@@ -100,7 +100,7 @@ export class BaseQuery extends Pagination {
100100
* @example
101101
* import contentstack from '@contentstack/delivery-sdk'
102102
*
103-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
103+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
104104
* const query = stack.contentType("contentTypeUid").entry().query();
105105
* const result = await query.skip("skip_value").find()
106106
* // OR
@@ -123,7 +123,7 @@ export class BaseQuery extends Pagination {
123123
* @example
124124
* import contentstack from '@contentstack/delivery-sdk'
125125
*
126-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
126+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
127127
* const query = stack.contentType("contentTypeUid").entry().query();
128128
* const result = await query.param("key", "value").find()
129129
* // OR
@@ -144,7 +144,7 @@ export class BaseQuery extends Pagination {
144144
* @example
145145
* import contentstack from '@contentstack/delivery-sdk'
146146
*
147-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
147+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
148148
* const query = stack.contentType("contentTypeUid").entry().query();
149149
* const result = await query.addParams({"key": "value"}).find()
150150
* // OR
@@ -165,7 +165,7 @@ export class BaseQuery extends Pagination {
165165
* @example
166166
* import contentstack from '@contentstack/delivery-sdk'
167167
*
168-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
168+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
169169
* const query = stack.contentType("contentTypeUid").entry().query();
170170
* const result = await query.removeParam("query_param_key").find()
171171
* // OR
@@ -187,17 +187,17 @@ export class BaseQuery extends Pagination {
187187
* @example
188188
* import contentstack from '@contentstack/delivery-sdk'
189189
*
190-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
190+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
191191
* const result = await stack.asset().find();
192192
* @example
193193
* import contentstack from '@contentstack/delivery-sdk'
194194
*
195-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
195+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
196196
* const result = await stack.contentType("contentType1Uid").entry().query().find();
197197
* @example
198198
* import contentstack from '@contentstack/delivery-sdk'
199199
*
200-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
200+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
201201
* const result = await stack.asset(asset_uid).fetch();
202202
*/
203203

‎src/lib/content-type.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export class ContentType {
2626
* @example
2727
* import contentstack from '@contentstack/delivery-sdk'
2828
*
29-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
29+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
3030
* const entry = stack.contentType("contentTypeUid").entry("entryUid");
3131
*/
3232
entry(uid: string): Entry;
@@ -45,7 +45,7 @@ export class ContentType {
4545
* @example
4646
* import contentstack from '@contentstack/delivery-sdk'
4747
*
48-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
48+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
4949
* const result = await stack.contentType(asset_uid).fetch();
5050
*/
5151
async fetch<T>(): Promise<T> {

‎src/lib/contentstack.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ let version = '{{VERSION}}';
1616
*
1717
* @example
1818
* import contentstack from '@contentstack/delivery-sdk'
19-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
19+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
2020
* @example
2121
* import contentstack from '@contentstack/delivery-sdk'
22-
* const stack = contentstack.Stack({
22+
* const stack = contentstack.stack({
2323
* apiKey: "apiKey",
2424
* deliveryToken: "deliveryToken",
2525
* environment: "environment",

‎src/lib/contenttype-query.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export class ContentTypeQuery {
1818
* @example
1919
* import contentstack from '@contentstack/delivery-sdk'
2020
*
21-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
21+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
2222
* const contentTypeQuery = stack.contentType();
2323
* const result = await contentTypeQuery.includeGlobalFieldSchema().find();
2424
*/
@@ -35,7 +35,7 @@ export class ContentTypeQuery {
3535
* @example
3636
* import contentstack from '@contentstack/delivery-sdk'
3737
*
38-
* const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
38+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
3939
* const contentTypeQuery = stack.contentType();
4040
* const result = await contentTypeQuery.find();
4141
*/

0 commit comments

Comments
 (0)