@supabase/storage-js - npm Package Compare versions

Comparing version 2.1.0-next.3 to 2.1.0-next.4

dist/main/lib/types.d.ts

@@ -66,6 +66,18 @@ export interface Bucket {
 export interface TransformOptions {
+    /**
+     * The width of the image in pixels.
+     */
     width?: number;
+    /**
+     * The height of the image in pixels.
+     */
     height?: number;
+    /**
+     * The resize mode can be cover, contain or fill. Defaults to cover.
+     * Cover resizes the image to maintain it's aspect ratio while filling the entire width and height.
+     * Contain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.
+     * Fill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit.
+     */
     resize?: 'cover' | 'contain' | 'fill';
 }
 //# sourceMappingURL=types.d.ts.map

dist/main/lib/version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "2.1.0-next.3";
+export declare const version = "2.1.0-next.4";
 //# sourceMappingURL=version.d.ts.map

dist/main/lib/version.js

@@ -5,3 +5,3 @@ "use strict";
 // generated by genversion
-exports.version = '2.1.0-next.3';
+exports.version = '2.1.0-next.4';
 //# sourceMappingURL=version.js.map

dist/main/packages/StorageFileApi.d.ts

@@ -89,3 +89,3 @@ /// <reference types="node" />
      * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform The visiting client will receive the transformed variant of the image by providing transform options
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -128,3 +128,3 @@ createSignedUrl(path: string, expiresIn: number, options?: {
      * @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
-     * @param options.download download a transformed image
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -145,4 +145,4 @@ download(path: string, options?: {
      * @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.
-     * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform adds image transformations parameters to the generated url
+     * @param options.download Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -149,0 +149,0 @@ getPublicUrl(path: string, options?: {

dist/main/packages/StorageFileApi.js

@@ -156,3 +156,3 @@ "use strict";
      * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform The visiting client will receive the transformed variant of the image by providing transform options
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -212,3 +212,3 @@ createSignedUrl(path, expiresIn, options) {
      * @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
-     * @param options.download download a transformed image
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -243,4 +243,4 @@ download(path, options) {
      * @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.
-     * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform adds image transformations parameters to the generated url
+     * @param options.download Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -247,0 +247,0 @@ getPublicUrl(path, options) {

dist/module/lib/types.d.ts

@@ -66,6 +66,18 @@ export interface Bucket {
 export interface TransformOptions {
+    /**
+     * The width of the image in pixels.
+     */
     width?: number;
+    /**
+     * The height of the image in pixels.
+     */
     height?: number;
+    /**
+     * The resize mode can be cover, contain or fill. Defaults to cover.
+     * Cover resizes the image to maintain it's aspect ratio while filling the entire width and height.
+     * Contain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.
+     * Fill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit.
+     */
     resize?: 'cover' | 'contain' | 'fill';
 }
 //# sourceMappingURL=types.d.ts.map

dist/module/lib/version.d.ts

@@ -1,2 +0,2 @@
-export declare const version = "2.1.0-next.3";
+export declare const version = "2.1.0-next.4";
 //# sourceMappingURL=version.d.ts.map

dist/module/lib/version.js

 // generated by genversion
-export const version = '2.1.0-next.3';
+export const version = '2.1.0-next.4';
 //# sourceMappingURL=version.js.map

dist/module/packages/StorageFileApi.d.ts

@@ -89,3 +89,3 @@ /// <reference types="node" />
      * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform The visiting client will receive the transformed variant of the image by providing transform options
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -128,3 +128,3 @@ createSignedUrl(path: string, expiresIn: number, options?: {
      * @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
-     * @param options.download download a transformed image
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -145,4 +145,4 @@ download(path: string, options?: {
      * @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.
-     * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform adds image transformations parameters to the generated url
+     * @param options.download Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -149,0 +149,0 @@ getPublicUrl(path: string, options?: {

dist/module/packages/StorageFileApi.js

@@ -154,3 +154,3 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
      * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform The visiting client will receive the transformed variant of the image by providing transform options
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -210,3 +210,3 @@ createSignedUrl(path, expiresIn, options) {
      * @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
-     * @param options.download download a transformed image
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -241,4 +241,4 @@ download(path, options) {
      * @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.
-     * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-     * @param options.transform adds image transformations parameters to the generated url
+     * @param options.download Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
+     * @param options.transform Transform the asset before serving it to the client.
      */
@@ -245,0 +245,0 @@ getPublicUrl(path, options) {

package.json

 {
   "name": "@supabase/storage-js",
-  "version": "2.1.0-next.3",
+  "version": "2.1.0-next.4",
   "description": "Isomorphic storage client for Supabase.",
@@ -5,0 +5,0 @@ "keywords": [

src/lib/types.ts

@@ -77,5 +77,17 @@ export interface Bucket {
 export interface TransformOptions {
+  /**
+   * The width of the image in pixels.
+   */
   width?: number
+  /**
+   * The height of the image in pixels.
+   */
   height?: number
+  /**
+   * The resize mode can be cover, contain or fill. Defaults to cover.
+   * Cover resizes the image to maintain it's aspect ratio while filling the entire width and height.
+   * Contain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.
+   * Fill resizes the image to fill the entire width and height. If the object's aspect ratio does not match the width and height, the image will be stretched to fit.
+   */
   resize?: 'cover' | 'contain' | 'fill'
 }

src/lib/version.ts

 // generated by genversion
-export const version = '2.1.0-next.3'
+export const version = '2.1.0-next.4'

src/packages/StorageFileApi.ts

@@ -268,3 +268,3 @@ import { isStorageError, StorageError } from '../lib/errors'
    * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-   * @param options.transform The visiting client will receive the transformed variant of the image by providing transform options
+   * @param options.transform Transform the asset before serving it to the client.
    */
@@ -363,3 +363,3 @@ async createSignedUrl(
    * @param path The full path and file name of the file to be downloaded. For example `folder/image.png`.
-   * @param options.download download a transformed image
+   * @param options.transform Transform the asset before serving it to the client.
    */
@@ -406,4 +406,4 @@ async download(
    * @param path The path and name of the file to generate the public URL for. For example `folder/image.png`.
-   * @param options.download triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
-   * @param options.transform adds image transformations parameters to the generated url
+   * @param options.download Triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename.
+   * @param options.transform Transform the asset before serving it to the client.
    */
@@ -410,0 +410,0 @@ getPublicUrl(

No alert changes

Improved metrics

Total package byte prevSize

216216

increased by0.79%

Lines of code

3305

increased by1.1%

No dependency changes