asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update Typedoc and regenerate references (#1994)

Browse Source 
* generated new services reference

* changed from automatic push to automated pull request

* updated typedoc, regenerated JS Client reference

* regenerated the reference after updating typedoc

* added action for js client
This commit is contained in:
Shahed Nasser
2022-08-04 17:29:52 +03:00
committed by GitHub
parent 6663a6290b
commit 02d5c1da88
630 changed files with 21256 additions and 16381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
docs/content/references/services/classes/ProductCollectionService.md
View File

@@ -1,5 +1,7 @@
# Class: ProductCollectionService
Provides layer to manipulate product collections.
## Hierarchy
- `"medusa-interfaces"`
@@ -24,7 +26,7 @@ BaseService.constructor
#### Defined in
[services/product-collection.js:11](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L11)
[packages/medusa/src/services/product-collection.js:11](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L11)
## Methods
@@ -45,7 +47,7 @@ BaseService.constructor
#### Defined in
[services/product-collection.js:170](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L170)
[packages/medusa/src/services/product-collection.js:170](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L170)
___
@@ -53,19 +55,23 @@ ___
▸ **create**(`collection`): `Promise`<`ProductCollection`\>
Creates a product collection
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `collection` | `any` | |
| `collection` | `any` | the collection to create |
#### Returns
`Promise`<`ProductCollection`\>
created collection
#### Defined in
[services/product-collection.js:104](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L104)
[packages/medusa/src/services/product-collection.js:104](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L104)
___
@@ -73,19 +79,23 @@ ___
▸ **delete**(`collectionId`): `Promise`<`any`\>
Deletes a product collection idempotently
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `collectionId` | `string` | |
| `collectionId` | `string` | id of collection to delete |
#### Returns
`Promise`<`any`\>
empty promise
#### Defined in
[services/product-collection.js:152](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L152)
[packages/medusa/src/services/product-collection.js:152](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L152)
___
@@ -93,20 +103,24 @@ ___
▸ **list**(`selector?`, `config?`): `Promise`<`any`\>
Lists product collections
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `any` | |
| `selector` | `any` | the query object for find |
| `config` | `any` | the config to be used for find |
#### Returns
`Promise`<`any`\>
the result of the find operation
#### Defined in
[services/product-collection.js:206](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L206)
[packages/medusa/src/services/product-collection.js:206](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L206)
___
@@ -114,20 +128,24 @@ ___
▸ **listAndCount**(`selector?`, `config?`): `Promise`<`any`\>
Lists product collections and add count.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `selector` | `any` | |
| `config` | `any` | |
| `selector` | `any` | the query object for find |
| `config` | `any` | the config to be used for find |
#### Returns
`Promise`<`any`\>
the result of the find operation
#### Defined in
[services/product-collection.js:221](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L221)
[packages/medusa/src/services/product-collection.js:221](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L221)
___
@@ -148,7 +166,7 @@ ___
#### Defined in
[services/product-collection.js:188](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L188)
[packages/medusa/src/services/product-collection.js:188](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L188)
___
@@ -156,20 +174,24 @@ ___
▸ **retrieve**(`collectionId`, `config?`): `Promise`<`ProductCollection`\>
Retrieves a product collection by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `collectionId` | `string` | |
| `config` | `any` | |
| `collectionId` | `string` | the id of the collection to retrieve. |
| `config` | `any` | the config of the collection to retrieve. |
#### Returns
`Promise`<`ProductCollection`\>
the collection.
#### Defined in
[services/product-collection.js:55](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L55)
[packages/medusa/src/services/product-collection.js:55](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L55)
___
@@ -177,20 +199,24 @@ ___
▸ **retrieveByHandle**(`collectionHandle`, `config?`): `Promise`<`ProductCollection`\>
Retrieves a product collection by id.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `collectionHandle` | `string` | |
| `config` | `any` | |
| `collectionHandle` | `string` | the handle of the collection to retrieve. |
| `config` | `any` | query config for request |
#### Returns
`Promise`<`ProductCollection`\>
the collection.
#### Defined in
[services/product-collection.js:81](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L81)
[packages/medusa/src/services/product-collection.js:81](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L81)
___
@@ -198,20 +224,24 @@ ___
▸ **update**(`collectionId`, `update`): `Promise`<`ProductCollection`\>
Updates a product collection
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `collectionId` | `string` | |
| `update` | `any` | |
| `collectionId` | `string` | id of collection to update |
| `update` | `any` | update object |
#### Returns
`Promise`<`ProductCollection`\>
update collection
#### Defined in
[services/product-collection.js:125](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L125)
[packages/medusa/src/services/product-collection.js:125](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L125)
___
@@ -231,4 +261,4 @@ ___
#### Defined in
[services/product-collection.js:32](https://github.com/medusajs/medusa/blob/32b066d92/packages/medusa/src/services/product-collection.js#L32)
[packages/medusa/src/services/product-collection.js:32](https://github.com/medusajs/medusa/blob/f406c8d4/packages/medusa/src/services/product-collection.js#L32)