u
This commit is contained in:
19
API.brand.md
19
API.brand.md
@@ -2,6 +2,25 @@
|
||||
|
||||
This document is auto-generated from the JSDoc comments in `src/store` by running `npm run api-doc`.
|
||||
|
||||
## `brand.addImage`
|
||||
|
||||
*Source: `src/store/brand/addImage.js`*
|
||||
|
||||
Adds an image to a brand, processing it into AVIF full and thumb variants.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| `googleAuthId` | `number` | The id of the Google auth user. |
|
||||
| `brandId` | `number` | The id of the brand. |
|
||||
| `image` | `Buffer` | The source image buffer. |
|
||||
| `[tx]` | `object` | Optional transaction to run within. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, fullHash: string, thumbW: number, thumbH: number, thumbHash: string, pics: Array<object>}>`
|
||||
|
||||
## `brand.delete`
|
||||
|
||||
*Source: `src/store/brand/delete.js`*
|
||||
|
||||
Reference in New Issue
Block a user