New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

gatsby-transformer-cloudinary

Package Overview
Dependencies
Maintainers
1
Versions
46
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gatsby-transformer-cloudinary - npm Package Compare versions

Comparing version

0.3.4
to
0.3.5

2

package.json
{
"name": "gatsby-transformer-cloudinary",
"version": "0.3.4",
"version": "0.3.5",
"description": "Transform local files into Cloudinary-managed assets for Gatsby sites.",

@@ -5,0 +5,0 @@ "main": "index.js",

37

README.md

@@ -110,12 +110,12 @@ # gatsby-transformer-cloudinary

| option | type | required | default value | description |
|------------------------|---------|----------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `cloudName` | string | true | n/a | Cloud name of your Cloudinary account, can be obtained from your [Cloudinary console](https://cloudinary.com/console/). This should be stored and retrieved as an environment variable. |
| `apiKey` | string | true | n/a | API Key of your Cloudinary account, can be obtained from your [Cloudinary console](https://cloudinary.com/console/). This should be stored and retrieved as an environment variable. |
| `apiSecret` | string | true | n/a | API Secret of your Cloudinary account, can be obtained from your [Cloudinary console](https://cloudinary.com/console/). This should be stored and retrieved as an environment variable. |
| `uploadFolder` | string | false | n/a | This is the name of the folder the images will be uploaded to on Cloudinary. It will be created on Cloudinary if it is not specified. |
| `fluidMaxWidth` | integer | false | 1000 | Max width set for responsive breakpoints images generated and returned on image upload. |
| `fluidMinWidth` | integer | false | 200 | Min width set for responsive breakpoints images generated and returned on image upload. |
| `createDerived` | boolean | false | true | This option is specifies the creation of derived images using the specified fluidMinWidth and fluidMaxWidth dimensions specified. |
| `breakpointsMaxImages` | integer | false | 5 | Set maximum number of responsive breakpoint images generated and returned on image upload. |
| option | type | required | default value | description |
|------------------------|-----------|----------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `cloudName` | `String` | true | n/a | Cloud name of your Cloudinary account, can be obtained from your [Cloudinary console](https://cloudinary.com/console/). This should be stored and retrieved as an environment variable. |
| `apiKey` | `String` | true | n/a | API Key of your Cloudinary account, can be obtained from your [Cloudinary console](https://cloudinary.com/console/). This should be stored and retrieved as an environment variable. |
| `apiSecret` | `String` | true | n/a | API Secret of your Cloudinary account, can be obtained from your [Cloudinary console](https://cloudinary.com/console/). This should be stored and retrieved as an environment variable. |
| `uploadFolder` | `String` | false | n/a | This is the name of the folder the images will be uploaded to on Cloudinary. It will be created on Cloudinary if it is not specified. |
| `fluidMaxWidth` | `Int` | false | 1000 | Max width set for responsive breakpoints images generated and returned on image upload. |
| `fluidMinWidth` | `Int` | false | 200 | Min width set for responsive breakpoints images generated and returned on image upload. |
| `createDerived` | `Boolean` | false | true | This option is specifies the creation of derived images using the specified fluidMinWidth and fluidMaxWidth dimensions specified. |
| `breakpointsMaxImages` | `Integer` | false | 5 | Set maximum number of responsive breakpoint images generated and returned on image upload. |

@@ -216,8 +216,13 @@ > Note: Setting a high max width such as 5000 will lead to the generation of a lot of derived images, between the max and min widths breakpoints on image upload. Use this option with care.

| argument | type | default | description |
| ----------------- | ----------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `transformations` | `[String!]` | `[]` | Transformations to apply to the image. Pass these as an array (e.g. `["e_grayscale", "ar_16:9"]`) |
| `chained` | `[String!]` | `[]` | For complex transformations, you may need to [chain transformations](https://cloudinary.com/documentation/chained_and_named_transformations). These are supplied as an array, with each link in the chain as an array item (e.g. `["e_grayscale", "l_overlay,g_center,o_60"]`) |
| `defaults` | `[String!]` | `["f_auto", "q_auto"]` | By default, this transformer will set the format and quality parameters to “auto”, which is a Good Idea™ from a performance standpoint. If you want to change these defaults, you can set this argument explicitly. |
| `base64Width` | `Int` | `30` | If you want to change the width of the placeholder image shown while the full-resolution image is loading, you can change this value. |
| argument | type | required | default | description |
|-------------------|-------------|----------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `cloudName` | `String` | true | `n/a` | Cloud name of your Cloudinary account, can be obtained from your [Cloudinary console](https://cloudinary.com/console/). This should be stored and retrieved as an environment variable. |
| `public_id` | `String` | true | `n/a` | Public ID of the image to retrieve from Cloudinary. This can be obtained from your Cloudinary account. |
| `transformations` | `[String!]` | false | `[]` | Array of transformations to be applied to the image. |
| `chained` | `[String!]` | false | `[]` | An array of chained transformations to be applied to the image. |
| `defaults` | `[String!]` | false | `["f_auto", "q_auto"]` | Default transformation applied to the image |
| `originalHeight` | `Int` | true | `n/a` | Height of the image fetched. This is required in gatsby-image to calculate the aspect ratio of the image. |
| `originalWidth` | `Int` | true | `n/a` | Desired width of the image. This is required in gatsby-image to calculate the aspect ratio. |
| `base64Width` | `String` | false | `30` | Base64 width of the image. |
| `version` | `Boolean` | false | `false` | Version number of image if applicable, eg. 300124291, 1241983. |

@@ -224,0 +229,0 @@ ### Arguments for `fixed`