{ "id": 0, "name": "@supabase/storage-js", "variant": "project", "kind": 1, "flags": {}, "children": [ { "id": 1, "name": "index", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { "id": 1404, "name": "StorageVectorsErrorCode", "variant": "declaration", "kind": 8, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error codes specific to S3 Vectors API\nMaps AWS service errors to application-friendly error codes" } ] }, "children": [ { "id": 1405, "name": "InternalError", "variant": "declaration", "kind": 16, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Internal server fault (HTTP 500)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 133, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L133" } ], "type": { "type": "literal", "value": "InternalError" } }, { "id": 1408, "name": "S3VectorBucketNotEmpty", "variant": "declaration", "kind": 16, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Delete bucket while not empty (HTTP 400)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 139, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L139" } ], "type": { "type": "literal", "value": "S3VectorBucketNotEmpty" } }, { "id": 1406, "name": "S3VectorConflictException", "variant": "declaration", "kind": 16, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Resource already exists / conflict (HTTP 409)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 135, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L135" } ], "type": { "type": "literal", "value": "S3VectorConflictException" } }, { "id": 1409, "name": "S3VectorMaxBucketsExceeded", "variant": "declaration", "kind": 16, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Exceeds bucket quota/limit (HTTP 400)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 141, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L141" } ], "type": { "type": "literal", "value": "S3VectorMaxBucketsExceeded" } }, { "id": 1410, "name": "S3VectorMaxIndexesExceeded", "variant": "declaration", "kind": 16, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Exceeds index quota/limit (HTTP 400)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 143, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L143" } ], "type": { "type": "literal", "value": "S3VectorMaxIndexesExceeded" } }, { "id": 1407, "name": "S3VectorNotFoundException", "variant": "declaration", "kind": 16, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Resource not found (HTTP 404)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 137, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L137" } ], "type": { "type": "literal", "value": "S3VectorNotFoundException" } } ], "groups": [ { "title": "Enumeration Members", "children": [1405, 1408, 1406, 1409, 1410, 1407] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 131, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L131" } ] }, { "id": 1340, "name": "StorageApiError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "API error returned from Storage service\nIncludes HTTP status code and service-specific error code" } ] }, "children": [ { "id": 1341, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 48, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L48" } ], "signatures": [ { "id": 1342, "name": "StorageApiError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 48, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L48" } ], "parameters": [ { "id": 1343, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1344, "name": "status", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1345, "name": "statusCode", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1346, "name": "namespace", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1328, "name": "ErrorNamespace", "package": "@supabase/storage-js" }, "defaultValue": "'storage'" } ], "type": { "type": "reference", "target": 1340, "name": "StorageApiError", "package": "@supabase/storage-js" }, "overwrites": { "type": "reference", "target": 1331, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", "target": 1330, "name": "StorageError.constructor" } }, { "id": 1347, "name": "status", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 45, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L45" } ], "type": { "type": "intrinsic", "name": "number" }, "overwrites": { "type": "reference", "target": 1338, "name": "StorageError.status" } }, { "id": 1348, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 46, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L46" } ], "type": { "type": "intrinsic", "name": "string" }, "overwrites": { "type": "reference", "target": 1339, "name": "StorageError.statusCode" } }, { "id": 1349, "name": "toJSON", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 60, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L60" } ], "signatures": [ { "id": 1350, "name": "toJSON", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 60, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L60" } ], "type": { "type": "reflection", "declaration": { "id": 1351, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1353, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 63, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L63" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1352, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 62, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L62" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1354, "name": "status", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 64, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L64" } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." }, { "id": 1355, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 65, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L65" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "children": [1353, 1352, 1354, 1355] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 61, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L61" } ] } } } ] } ], "groups": [ { "title": "Constructors", "children": [1341] }, { "title": "Properties", "children": [1347, 1348] }, { "title": "Methods", "children": [1349] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 44, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L44" } ], "extendedTypes": [ { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } ], "extendedBy": [ { "type": "reference", "target": 1377, "name": "StorageVectorsApiError" } ] }, { "id": 963, "name": "StorageClient", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { "id": 964, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 26, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L26" } ], "signatures": [ { "id": 965, "name": "StorageClient", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a client for Storage buckets, files, analytics, and vectors." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@example", "name": "Creating a Storage client", "content": [ { "kind": "code", "text": "```ts\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {\n apikey: 'public-anon-key',\n})\nconst avatars = storage.from('avatars')\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 26, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L26" } ], "parameters": [ { "id": 966, "name": "url", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 967, "name": "headers", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 968, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 28, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L28" } ], "indexSignatures": [ { "id": 969, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 28, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L28" } ], "parameters": [ { "id": 970, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } }, "defaultValue": "{}" }, { "id": 971, "name": "fetch", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 972, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 973, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 974, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 975, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 976, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 977, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 978, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 979, "name": "opts", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1091, "name": "StorageClientOptions", "package": "@supabase/storage-js" } } ], "type": { "type": "reference", "target": 963, "name": "StorageClient", "package": "@supabase/storage-js" }, "overwrites": { "type": "reference", "target": 138, "name": "default.constructor" } } ], "overwrites": { "type": "reference", "target": 137, "name": "default.constructor" } }, { "id": 985, "name": "analytics", "variant": "declaration", "kind": 262144, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 79, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L79" } ], "getSignature": { "id": 986, "name": "analytics", "variant": "signature", "kind": 524288, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Access analytics storage operations using Iceberg tables.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Analytics Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A StorageAnalyticsClient instance configured with the current storage settings." } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 79, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L79" } ], "type": { "type": "reference", "target": 48, "name": "StorageAnalyticsClient", "package": "@supabase/storage-js", "qualifiedName": "default" } } }, { "id": 983, "name": "vectors", "variant": "declaration", "kind": 262144, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 61, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L61" } ], "getSignature": { "id": 984, "name": "vectors", "variant": "signature", "kind": 524288, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Access vector storage operations.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A StorageVectorsClient instance configured with the current storage settings." } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 61, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L61" } ], "type": { "type": "reference", "target": 544, "name": "StorageVectorsClient", "package": "@supabase/storage-js" } } }, { "id": 1005, "name": "createBucket", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 185, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L185" } ], "signatures": [ { "id": 1006, "name": "createBucket", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Creates a new Storage bucket" } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing newly created bucket name or error" } ] }, { "tag": "@example", "name": "Create bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .createBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"name\": \"avatars\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`insert`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 185, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L185" } ], "parameters": [ { "id": 1007, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A unique identifier for the bucket you are creating." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1008, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1009, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1012, "name": "allowedMimeTypes", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 190, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L190" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] } }, { "id": 1011, "name": "fileSizeLimit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 189, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L189" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 1010, "name": "public", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 188, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1013, "name": "type", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "(private-beta) specifies the bucket type. see " }, { "kind": "code", "text": "`BucketType`" }, { "kind": "text", "text": " for more details.\n - default bucket type is " }, { "kind": "code", "text": "`STANDARD`" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 191, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L191" } ], "type": { "type": "reference", "target": 1102, "name": "BucketType", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [1012, 1011, 1010, 1013] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 187, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L187" } ] } }, "defaultValue": "..." } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1014, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1015, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 197, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L197" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Pick" }, "typeArguments": [ { "type": "reference", "target": 1103, "name": "Bucket", "package": "@supabase/storage-js" }, { "type": "literal", "value": "name" } ], "name": "Pick", "package": "typescript" } }, { "id": 1016, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 198, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L198" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1015, 1016] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 196, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L196" } ] } }, { "type": "reflection", "declaration": { "id": 1017, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1018, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 201, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201" } ], "type": { "type": "literal", "value": null } }, { "id": 1019, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 202, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L202" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [1018, 1019] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 200, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L200" } ] } } ] } ], "name": "Promise", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 172, "name": "default.createBucket" } } ], "inheritedFrom": { "type": "reference", "target": 171, "name": "default.createBucket" } }, { "id": 1047, "name": "deleteBucket", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 372, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L372" } ], "signatures": [ { "id": 1048, "name": "deleteBucket", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " }, { "kind": "code", "text": "`empty()`" }, { "kind": "text", "text": " the bucket." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with success message or error" } ] }, { "tag": "@example", "name": "Delete bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .deleteBucket('avatars')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`delete`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 372, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L372" } ], "parameters": [ { "id": 1049, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The unique identifier of the bucket you would like to delete." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1050, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1051, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 374, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L374" } ], "type": { "type": "reflection", "declaration": { "id": 1052, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1053, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 374, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L374" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1053] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 374, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L374" } ] } } }, { "id": 1054, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 375, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L375" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1051, 1054] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 373, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L373" } ] } }, { "type": "reflection", "declaration": { "id": 1055, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1056, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 378, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" } ], "type": { "type": "literal", "value": null } }, { "id": 1057, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 379, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L379" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [1056, 1057] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 377, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L377" } ] } } ] } ], "name": "Promise", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 214, "name": "default.deleteBucket" } } ], "inheritedFrom": { "type": "reference", "target": 213, "name": "default.deleteBucket" } }, { "id": 1036, "name": "emptyBucket", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 326, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L326" } ], "signatures": [ { "id": 1037, "name": "emptyBucket", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Removes all objects inside a single bucket." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with success message or error" } ] }, { "tag": "@example", "name": "Empty bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .emptyBucket('avatars')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully emptied\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`delete`" }, { "kind": "text", "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 326, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L326" } ], "parameters": [ { "id": 1038, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The unique identifier of the bucket you would like to empty." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1039, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1040, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 328, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L328" } ], "type": { "type": "reflection", "declaration": { "id": 1041, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1042, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 328, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L328" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1042] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 328, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L328" } ] } } }, { "id": 1043, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 329, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L329" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1040, 1043] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 327, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L327" } ] } }, { "type": "reflection", "declaration": { "id": 1044, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1045, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 332, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L332" } ], "type": { "type": "literal", "value": null } }, { "id": 1046, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 333, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [1045, 1046] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 331, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" } ] } } ] } ], "name": "Promise", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 203, "name": "default.emptyBucket" } } ], "inheritedFrom": { "type": "reference", "target": 202, "name": "default.emptyBucket" } }, { "id": 980, "name": "from", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 46, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L46" } ], "signatures": [ { "id": 981, "name": "from", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Perform file operation in a bucket." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@example", "name": "Accessing a bucket", "content": [ { "kind": "code", "text": "```typescript\nconst avatars = supabase.storage.from('avatars')\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 46, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L46" } ], "parameters": [ { "id": 982, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The bucket id to operate on." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 261, "name": "StorageFileApi", "package": "@supabase/storage-js", "qualifiedName": "default" } } ] }, { "id": 996, "name": "getBucket", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 127, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L127" } ], "signatures": [ { "id": 997, "name": "getBucket", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retrieves the details of an existing Storage bucket." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing bucket details or error" } ] }, { "tag": "@example", "name": "Get bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .getBucket('avatars')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"id\": \"avatars\",\n \"name\": \"avatars\",\n \"owner\": \"\",\n \"public\": false,\n \"file_size_limit\": 1024,\n \"allowed_mime_types\": [\n \"image/png\"\n ],\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 127, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L127" } ], "parameters": [ { "id": 998, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The unique identifier of the bucket you would like to retrieve." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 999, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1000, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 129, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" } ], "type": { "type": "reference", "target": 1103, "name": "Bucket", "package": "@supabase/storage-js" } }, { "id": 1001, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 130, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L130" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1000, 1001] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 128, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L128" } ] } }, { "type": "reflection", "declaration": { "id": 1002, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1003, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 133, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L133" } ], "type": { "type": "literal", "value": null } }, { "id": 1004, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 134, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L134" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [1003, 1004] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 132, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L132" } ] } } ] } ], "name": "Promise", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 163, "name": "default.getBucket" } } ], "inheritedFrom": { "type": "reference", "target": 162, "name": "default.getBucket" } }, { "id": 987, "name": "listBuckets", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 70, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L70" } ], "signatures": [ { "id": 988, "name": "listBuckets", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Retrieves the details of all Storage buckets within an existing project." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing array of buckets or error" } ] }, { "tag": "@example", "name": "List buckets", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets()\n```" } ] }, { "tag": "@example", "name": "List buckets with options", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod'\n })\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 70, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L70" } ], "parameters": [ { "id": 989, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Query parameters for listing buckets" } ] }, "type": { "type": "reference", "target": 1113, "name": "ListBucketOptions", "package": "@supabase/storage-js", "highlightedProperties": { "limit": [ { "kind": "text", "text": "Maximum number of buckets to return" } ], "offset": [ { "kind": "text", "text": "Number of buckets to skip" } ], "sortColumn": [ { "kind": "text", "text": "Column to sort by ('id', 'name', 'created_at', 'updated_at')" } ], "sortOrder": [ { "kind": "text", "text": "Sort order ('asc' or 'desc')" } ], "search": [ { "kind": "text", "text": "Search term to filter bucket names" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 990, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 991, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 72, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L72" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1103, "name": "Bucket", "package": "@supabase/storage-js" } } }, { "id": 992, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 73, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L73" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [991, 992] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 71, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" } ] } }, { "type": "reflection", "declaration": { "id": 993, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 994, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 76, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L76" } ], "type": { "type": "literal", "value": null } }, { "id": 995, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 77, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L77" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [994, 995] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 75, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L75" } ] } } ] } ], "name": "Promise", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 154, "name": "default.listBuckets" } } ], "inheritedFrom": { "type": "reference", "target": 153, "name": "default.listBuckets" } }, { "id": 1075, "name": "setHeader", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "signatures": [ { "id": 1076, "name": "setHeader", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "parameters": [ { "id": 1077, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1078, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header value" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 245, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", "target": 244, "name": "default.setHeader" } }, { "id": 1073, "name": "throwOnError", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "signatures": [ { "id": 1074, "name": "throwOnError", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 243, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", "target": 242, "name": "default.throwOnError" } }, { "id": 1020, "name": "updateBucket", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 263, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L263" } ], "signatures": [ { "id": 1021, "name": "updateBucket", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Updates a Storage bucket" } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing success message or error" } ] }, { "tag": "@example", "name": "Update bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .updateBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully updated\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`update`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 263, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L263" } ], "parameters": [ { "id": 1022, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A unique identifier for the bucket you are updating." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1023, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 1024, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1027, "name": "allowedMimeTypes", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 268, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L268" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] } }, { "id": 1026, "name": "fileSizeLimit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 267, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 1025, "name": "public", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 266, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L266" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [1027, 1026, 1025] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 265, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L265" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1028, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1029, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 272, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" } ], "type": { "type": "reflection", "declaration": { "id": 1030, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1031, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 272, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1031] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 272, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" } ] } } }, { "id": 1032, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 273, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L273" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1029, 1032] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 271, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L271" } ] } }, { "type": "reflection", "declaration": { "id": 1033, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1034, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 276, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" } ], "type": { "type": "literal", "value": null } }, { "id": 1035, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 277, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L277" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [1034, 1035] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 275, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L275" } ] } } ] } ], "name": "Promise", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 187, "name": "default.updateBucket" } } ], "inheritedFrom": { "type": "reference", "target": 186, "name": "default.updateBucket" } } ], "groups": [ { "title": "Constructors", "children": [964] }, { "title": "Accessors", "children": [985, 983] }, { "title": "Methods", "children": [1005, 1047, 1036, 980, 996, 987, 1075, 1073, 1020] } ], "categories": [ { "title": "Analytics Buckets", "children": [985] }, { "title": "File Buckets", "children": [964, 1005, 1047, 1036, 980, 996, 987, 1020] }, { "title": "Other", "children": [1075, 1073] }, { "title": "Vector Buckets", "children": [983] } ], "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 11, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L11" } ], "extendedTypes": [ { "type": "reference", "target": 136, "name": "default", "package": "@supabase/storage-js" } ] }, { "id": 1329, "name": "StorageError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Base error class for all Storage errors\nSupports both 'storage' and 'vectors' namespaces" } ] }, "children": [ { "id": 1330, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 17, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L17" } ], "signatures": [ { "id": 1331, "name": "StorageError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 17, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L17" } ], "parameters": [ { "id": 1332, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1333, "name": "namespace", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1328, "name": "ErrorNamespace", "package": "@supabase/storage-js" }, "defaultValue": "'storage'" }, { "id": 1334, "name": "status", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1335, "name": "statusCode", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" }, "overwrites": { "type": "reference", "target": -1, "name": "Error.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "Error.constructor" } }, { "id": 1338, "name": "status", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 14, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L14" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 1339, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 15, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L15" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Constructors", "children": [1330] }, { "title": "Properties", "children": [1338, 1339] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 11, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L11" } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Error" }, "name": "Error", "package": "typescript" } ], "extendedBy": [ { "type": "reference", "target": 1340, "name": "StorageApiError" }, { "type": "reference", "target": 1358, "name": "StorageUnknownError" }, { "type": "reference", "target": 1369, "name": "StorageVectorsError" } ] }, { "id": 1358, "name": "StorageUnknownError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unknown error that doesn't match expected error patterns\nWraps the original error for debugging" } ] }, "children": [ { "id": 1359, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 77, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L77" } ], "signatures": [ { "id": 1360, "name": "StorageUnknownError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 77, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L77" } ], "parameters": [ { "id": 1361, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1362, "name": "originalError", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 1363, "name": "namespace", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1328, "name": "ErrorNamespace", "package": "@supabase/storage-js" }, "defaultValue": "'storage'" } ], "type": { "type": "reference", "target": 1358, "name": "StorageUnknownError", "package": "@supabase/storage-js" }, "overwrites": { "type": "reference", "target": 1331, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", "target": 1330, "name": "StorageError.constructor" } }, { "id": 1364, "name": "originalError", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 75, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L75" } ], "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 1367, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 14, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L14" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] }, "inheritedFrom": { "type": "reference", "target": 1338, "name": "StorageError.status" } }, { "id": 1368, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 15, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L15" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "target": 1339, "name": "StorageError.statusCode" } } ], "groups": [ { "title": "Constructors", "children": [1359] }, { "title": "Properties", "children": [1364, 1367, 1368] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 74, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L74" } ], "extendedTypes": [ { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } ], "extendedBy": [ { "type": "reference", "target": 1394, "name": "StorageVectorsUnknownError" } ] }, { "id": 1377, "name": "StorageVectorsApiError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Use StorageApiError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" } ] } ] }, "children": [ { "id": 1378, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 112, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L112" } ], "signatures": [ { "id": 1379, "name": "StorageVectorsApiError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 112, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L112" } ], "parameters": [ { "id": 1380, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1381, "name": "status", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "number" } }, { "id": 1382, "name": "statusCode", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 1377, "name": "StorageVectorsApiError", "package": "@supabase/storage-js" }, "overwrites": { "type": "reference", "target": 1342, "name": "StorageApiError.constructor" } } ], "overwrites": { "type": "reference", "target": 1341, "name": "StorageApiError.constructor" } }, { "id": 1383, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 45, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L45" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 1347, "name": "StorageApiError.status" } }, { "id": 1384, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 46, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L46" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 1348, "name": "StorageApiError.statusCode" } }, { "id": 1385, "name": "toJSON", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 60, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L60" } ], "signatures": [ { "id": 1386, "name": "toJSON", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 60, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L60" } ], "type": { "type": "reflection", "declaration": { "id": 1387, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1389, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 63, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L63" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1388, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 62, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L62" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." }, { "id": 1390, "name": "status", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 64, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L64" } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "..." }, { "id": 1391, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 65, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L65" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "..." } ], "groups": [ { "title": "Properties", "children": [1389, 1388, 1390, 1391] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 61, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L61" } ] } }, "inheritedFrom": { "type": "reference", "target": 1350, "name": "StorageApiError.toJSON" } } ], "inheritedFrom": { "type": "reference", "target": 1349, "name": "StorageApiError.toJSON" } } ], "groups": [ { "title": "Constructors", "children": [1378] }, { "title": "Properties", "children": [1383, 1384] }, { "title": "Methods", "children": [1385] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 111, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L111" } ], "extendedTypes": [ { "type": "reference", "target": 1340, "name": "StorageApiError", "package": "@supabase/storage-js" } ] }, { "id": 1369, "name": "StorageVectorsError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Use StorageError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" } ] } ] }, "children": [ { "id": 1370, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 93, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L93" } ], "signatures": [ { "id": 1371, "name": "StorageVectorsError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 93, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L93" } ], "parameters": [ { "id": 1372, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 1369, "name": "StorageVectorsError", "package": "@supabase/storage-js" }, "overwrites": { "type": "reference", "target": 1331, "name": "StorageError.constructor" } } ], "overwrites": { "type": "reference", "target": 1330, "name": "StorageError.constructor" } }, { "id": 1375, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 14, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L14" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] }, "inheritedFrom": { "type": "reference", "target": 1338, "name": "StorageError.status" } }, { "id": 1376, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 15, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L15" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "target": 1339, "name": "StorageError.statusCode" } } ], "groups": [ { "title": "Constructors", "children": [1370] }, { "title": "Properties", "children": [1375, 1376] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 92, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L92" } ], "extendedTypes": [ { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } ] }, { "id": 1394, "name": "StorageVectorsUnknownError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Use StorageUnknownError with namespace='vectors' instead\nAlias for backward compatibility with existing vector storage code" } ] } ] }, "children": [ { "id": 1395, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 122, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L122" } ], "signatures": [ { "id": 1396, "name": "StorageVectorsUnknownError", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 122, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L122" } ], "parameters": [ { "id": 1397, "name": "message", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 1398, "name": "originalError", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "reference", "target": 1394, "name": "StorageVectorsUnknownError", "package": "@supabase/storage-js" }, "overwrites": { "type": "reference", "target": 1360, "name": "StorageUnknownError.constructor" } } ], "overwrites": { "type": "reference", "target": 1359, "name": "StorageUnknownError.constructor" } }, { "id": 1399, "name": "originalError", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 75, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L75" } ], "type": { "type": "intrinsic", "name": "unknown" }, "inheritedFrom": { "type": "reference", "target": 1364, "name": "StorageUnknownError.originalError" } }, { "id": 1402, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 14, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L14" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "number" } ] }, "inheritedFrom": { "type": "reference", "target": 1367, "name": "StorageUnknownError.status" } }, { "id": 1403, "name": "statusCode", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 15, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L15" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "undefined" }, { "type": "intrinsic", "name": "string" } ] }, "inheritedFrom": { "type": "reference", "target": 1368, "name": "StorageUnknownError.statusCode" } } ], "groups": [ { "title": "Constructors", "children": [1395] }, { "title": "Properties", "children": [1399, 1402, 1403] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 121, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L121" } ], "extendedTypes": [ { "type": "reference", "target": 1358, "name": "StorageUnknownError", "package": "@supabase/storage-js" } ] }, { "id": 1119, "name": "AnalyticBucket", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Represents an Analytics Bucket using Apache Iceberg table format.\nAnalytics buckets are optimized for analytical queries and data processing." } ] }, "children": [ { "id": 1123, "name": "created_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ISO 8601 timestamp of bucket creation" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 42, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L42" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1122, "name": "format", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Storage format used (e.g., 'iceberg')" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 40, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L40" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1120, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique identifier for the bucket" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 36, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L36" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1121, "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Bucket type - always 'ANALYTICS' for analytics buckets" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 38, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L38" } ], "type": { "type": "literal", "value": "ANALYTICS" } }, { "id": 1124, "name": "updated_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "ISO 8601 timestamp of last update" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 44, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L44" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1123, 1122, 1120, 1121, 1124] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 34, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L34" } ] }, { "id": 1103, "name": "Bucket", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1109, "name": "allowed_mime_types", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 16, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L16" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1110, "name": "created_at", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 17, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L17" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1108, "name": "file_size_limit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 15, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L15" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1104, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 11, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L11" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1106, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 13, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L13" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1107, "name": "owner", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 14, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L14" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1112, "name": "public", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 19, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L19" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1105, "name": "type", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 12, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L12" } ], "type": { "type": "reference", "target": 1102, "name": "BucketType", "package": "@supabase/storage-js" } }, { "id": 1111, "name": "updated_at", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 18, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L18" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1109, 1110, 1108, 1104, 1106, 1107, 1112, 1105, 1111] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 10, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L10" } ] }, { "id": 1283, "name": "DeleteVectorsOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for batch deleting vectors" } ] }, "children": [ { "id": 1285, "name": "indexName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the index" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 549, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L549" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1286, "name": "keys", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of vector keys to delete (1-500 items)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 550, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L550" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1284, "name": "vectorBucketName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the vector bucket" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 548, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L548" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1285, 1286, 1284] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 547, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L547" } ] }, { "id": 1168, "name": "DestinationOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1169, "name": "destinationBucket", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 176, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L176" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1169] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 175, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L175" } ] }, { "id": 1221, "name": "EncryptionConfiguration", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Configuration for encryption at rest" } ] }, "children": [ { "id": 1222, "name": "kmsKeyArn", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "ARN of the KMS key used for encryption" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 362, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L362" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1223, "name": "sseType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Server-side encryption type (e.g., 'KMS')" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 363, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L363" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1222, 1223] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 361, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L361" } ] }, { "id": 1317, "name": "ErrorResponse", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Standard response wrapper for failed operations" } ] }, "children": [ { "id": 1318, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Null on error" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 646, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L646" } ], "type": { "type": "literal", "value": null } }, { "id": 1319, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "StorageError with details (named StorageVectorsError for vector operations)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 647, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L647" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [1318, 1319] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 645, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L645" } ] }, { "id": 1200, "name": "FetchParameters", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1202, "name": "cache", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Controls how the request interacts with the browser's HTTP cache.\n- 'default': Use standard cache behavior\n- 'no-store': Bypass cache entirely (useful in Edge Functions)\n- 'reload': Bypass cache but update it with response\n- 'no-cache': Validate with server before using cached response\n- 'force-cache': Use cache even if stale\n- 'only-if-cached': Only use cache, fail if not cached" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 296, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L296" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "default" }, { "type": "literal", "value": "no-store" }, { "type": "literal", "value": "reload" }, { "type": "literal", "value": "no-cache" }, { "type": "literal", "value": "force-cache" }, { "type": "literal", "value": "only-if-cached" } ] } }, { "id": 1201, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Pass in an AbortController's signal to cancel the request." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 285, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L285" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" } } ], "groups": [ { "title": "Properties", "children": [1202, 1201] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 281, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L281" } ] }, { "id": 1125, "name": "FileMetadata", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Metadata object returned by the Storage API for files\nContains information about file size, type, caching, and HTTP response details" } ] }, "children": [ { "id": 1129, "name": "cacheControl", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Cache control directive (e.g., \"max-age=3600\")" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 59, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L59" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1131, "name": "contentLength", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Content length in bytes (usually same as size)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 63, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L63" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1126, "name": "eTag", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Entity tag for caching and conditional requests" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 53, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L53" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1132, "name": "httpStatusCode", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "HTTP status code from the storage backend" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 65, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L65" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1130, "name": "lastModified", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Last modification timestamp (ISO 8601)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 61, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L61" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1128, "name": "mimetype", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "MIME type of the file" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 57, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L57" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1127, "name": "size", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "File size in bytes" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 55, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L55" } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [1129, 1131, 1126, 1132, 1130, 1128, 1127] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 51, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L51" } ], "indexSignatures": [ { "id": 1133, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Any additional custom metadata stored with the file" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 67, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L67" } ], "parameters": [ { "id": 1134, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "any" } } ] }, { "id": 1135, "name": "FileObject", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "File object returned by the List V1 API (list() method)\nNote: Folder entries will have null values for most fields except name\n\nWarning: Some fields may not be present in all API responses. Fields like\nbucket_id, owner, and buckets are not returned by list() operations." } ] }, "children": [ { "id": 1142, "name": "bucket_id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Bucket identifier - NOT returned by list() operations.\nMay be present in remove() responses. Do not rely on this field." } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 94, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L94" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1144, "name": "buckets", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Bucket object - NOT returned by list() or remove() operations.\nThis field should not be relied upon." } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 104, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L104" } ], "type": { "type": "reference", "target": 1103, "name": "Bucket", "package": "@supabase/storage-js" } }, { "id": 1139, "name": "created_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creation timestamp (null for folders)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 85, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L85" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 1137, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique identifier for the file (null for folders)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 81, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L81" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 1140, "name": "last_accessed_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Last access timestamp (null for folders)" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 87, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L87" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 1141, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "File metadata including size, mimetype, etc. (null for folders)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 89, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L89" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": 1125, "name": "FileMetadata", "package": "@supabase/storage-js" } ] } }, { "id": 1136, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "File or folder name (relative to the prefix) - always present" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 79, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L79" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1143, "name": "owner", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Owner identifier - NOT returned by list() or remove() operations.\nThis field should not be relied upon." } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 99, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L99" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1138, "name": "updated_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Last update timestamp (null for folders)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 83, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L83" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } } ], "groups": [ { "title": "Properties", "children": [1142, 1144, 1139, 1137, 1140, 1141, 1136, 1143, 1138] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 77, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L77" } ] }, { "id": 1145, "name": "FileObjectV2", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "File object returned by the Info endpoint (info() method)\nContains detailed metadata for a specific file" } ] }, "children": [ { "id": 1149, "name": "bucket_id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Bucket identifier" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 119, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L119" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1152, "name": "cache_control", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Cache control header value" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 125, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L125" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1153, "name": "content_type", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "MIME content type" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 127, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L127" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1150, "name": "created_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creation timestamp" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 121, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L121" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1154, "name": "etag", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Entity tag for caching" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 129, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L129" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1146, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique identifier for the file" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 113, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L113" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1155, "name": "last_modified", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Last modification timestamp (replaces updated_at)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 131, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L131" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1156, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Custom file metadata" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 133, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L133" } ], "type": { "type": "reference", "target": 1125, "name": "FileMetadata", "package": "@supabase/storage-js" } }, { "id": 1148, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "File name" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 117, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L117" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1151, "name": "size", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "File size in bytes" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 123, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L123" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1157, "name": "updated_at", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "The API returns last_modified instead.\nThis field may not be present in responses." } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 138, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L138" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1147, "name": "version", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "File version identifier" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 115, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L115" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1149, 1152, 1153, 1150, 1154, 1146, 1155, 1156, 1148, 1151, 1157, 1147] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 111, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L111" } ] }, { "id": 1161, "name": "FileOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1162, "name": "cacheControl", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the " }, { "kind": "code", "text": "`Cache-Control: max-age=`" }, { "kind": "text", "text": " header. Defaults to 3600 seconds." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 150, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L150" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1163, "name": "contentType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "the " }, { "kind": "code", "text": "`Content-Type`" }, { "kind": "text", "text": " header value. Should be specified if using a " }, { "kind": "code", "text": "`fileBody`" }, { "kind": "text", "text": " that is neither " }, { "kind": "code", "text": "`Blob`" }, { "kind": "text", "text": " nor " }, { "kind": "code", "text": "`File`" }, { "kind": "text", "text": " nor " }, { "kind": "code", "text": "`FormData`" }, { "kind": "text", "text": ", otherwise will default to " }, { "kind": "code", "text": "`text/plain;charset=UTF-8`" }, { "kind": "text", "text": "." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 154, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L154" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1165, "name": "duplex", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The duplex option is a string parameter that enables or disables duplex streaming, allowing for both reading and writing data in the same stream. It can be passed as an option to the fetch() method." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 162, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L162" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1167, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optionally add extra headers" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 172, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L172" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "string" } ], "name": "Record", "package": "typescript" } }, { "id": 1166, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The metadata option is an object that allows you to store additional information about the file. This information can be used to filter and search for files. The metadata object can contain any key-value pairs you want to store." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 167, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L167" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } }, { "id": 1164, "name": "upsert", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "When upsert is set to true, the file is overwritten if it exists. When set to false, an error is thrown if the object already exists. Defaults to false." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 158, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L158" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [1162, 1163, 1165, 1167, 1166, 1164] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 146, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L146" } ] }, { "id": 1271, "name": "GetVectorsOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for batch reading vectors" } ] }, "children": [ { "id": 1273, "name": "indexName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the index" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 515, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L515" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1274, "name": "keys", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of vector keys to retrieve" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 516, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L516" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 1275, "name": "returnData", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to include vector data in response" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 517, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L517" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1276, "name": "returnMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to include metadata in response" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 518, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L518" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1272, "name": "vectorBucketName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the vector bucket" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 514, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L514" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1273, 1274, 1275, 1276, 1272] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 513, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L513" } ] }, { "id": 1277, "name": "GetVectorsResponse", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response from getting vectors" } ] }, "children": [ { "id": 1278, "name": "vectors", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of retrieved vector objects" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 526, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L526" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1247, "name": "VectorMatch", "package": "@supabase/storage-js" } } } ], "groups": [ { "title": "Properties", "children": [1278] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 525, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L525" } ] }, { "id": 1113, "name": "ListBucketOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1114, "name": "limit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 23, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L23" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1115, "name": "offset", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 24, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L24" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1118, "name": "search", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 27, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L27" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1116, "name": "sortColumn", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 25, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L25" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "id" }, { "type": "literal", "value": "name" }, { "type": "literal", "value": "created_at" }, { "type": "literal", "value": "updated_at" } ] } }, { "id": 1117, "name": "sortOrder", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 26, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L26" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "asc" }, { "type": "literal", "value": "desc" } ] } } ], "groups": [ { "title": "Properties", "children": [1114, 1115, 1118, 1116, 1117] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 22, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L22" } ] }, { "id": 1261, "name": "ListIndexesOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for listing indexes within a bucket" } ] }, "children": [ { "id": 1264, "name": "maxResults", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Maximum number of results to return (default: 100)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 491, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L491" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1265, "name": "nextToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Token for pagination from previous response" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 492, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L492" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1263, "name": "prefix", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Filter indexes by name prefix" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 490, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L490" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1262, "name": "vectorBucketName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the parent vector bucket" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 489, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L489" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1264, 1265, 1263, 1262] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 488, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L488" } ] }, { "id": 1266, "name": "ListIndexesResponse", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response from listing indexes" } ] }, "children": [ { "id": 1267, "name": "indexes", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of index names" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 501, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L501" } ], "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 1268, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1269, "name": "indexName", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 501, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L501" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1269] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 501, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L501" } ] } } } }, { "id": 1270, "name": "nextToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Token for fetching next page (if more results exist)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 502, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L502" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1267, 1270] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 500, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L500" } ] }, { "id": 1252, "name": "ListVectorBucketsOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for fetching vector buckets" } ] }, "children": [ { "id": 1254, "name": "maxResults", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Maximum number of results to return (default: 100)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 467, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L467" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1255, "name": "nextToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Token for pagination from previous response" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 468, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L468" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1253, "name": "prefix", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Filter buckets by name prefix" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 466, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L466" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1254, 1255, 1253] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 465, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L465" } ] }, { "id": 1256, "name": "ListVectorBucketsResponse", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response from listing vector buckets" } ] }, "children": [ { "id": 1260, "name": "nextToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Token for fetching next page (if more results exist)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 478, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L478" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1257, "name": "vectorBuckets", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of bucket names" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 477, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L477" } ], "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 1258, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1259, "name": "vectorBucketName", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 477, "character": 19, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L477" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1259] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 477, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L477" } ] } } } } ], "groups": [ { "title": "Properties", "children": [1260, 1257] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 476, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L476" } ] }, { "id": 1287, "name": "ListVectorsOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for listing/scanning vectors in an index\nSupports parallel scanning via segment configuration" } ] }, "children": [ { "id": 1289, "name": "indexName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the index" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 567, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L567" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1290, "name": "maxResults", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Maximum number of results to return (default: 500, max: 1000)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 568, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L568" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1291, "name": "nextToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Token for pagination from previous response" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 569, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L569" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1292, "name": "returnData", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to include vector data in response" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 570, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L570" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1293, "name": "returnMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to include metadata in response" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 571, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L571" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1294, "name": "segmentCount", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Total number of parallel segments (1-16)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 572, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L572" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1295, "name": "segmentIndex", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Zero-based index of this segment (0 to segmentCount-1)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 573, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L573" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1288, "name": "vectorBucketName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the vector bucket" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 566, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L566" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1289, 1290, 1291, 1292, 1293, 1294, 1295, 1288] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 565, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L565" } ] }, { "id": 1296, "name": "ListVectorsResponse", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response from listing vectors" } ] }, "children": [ { "id": 1298, "name": "nextToken", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Token for fetching next page (if more results exist)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 583, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L583" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1297, "name": "vectors", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of vector objects" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 582, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L582" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1247, "name": "VectorMatch", "package": "@supabase/storage-js" } } } ], "groups": [ { "title": "Properties", "children": [1298, 1297] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 581, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L581" } ] }, { "id": 1203, "name": "Metadata", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1204, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 301, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L301" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1204] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 300, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L300" } ] }, { "id": 1228, "name": "MetadataConfiguration", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Metadata configuration for vector index\nDefines which metadata keys should not be indexed for filtering" } ] }, "children": [ { "id": 1229, "name": "nonFilterableMetadataKeys", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Array of metadata keys that cannot be used in filters" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 384, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L384" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "groups": [ { "title": "Properties", "children": [1229] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 383, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L383" } ] }, { "id": 1279, "name": "PutVectorsOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for batch inserting/updating vectors" } ] }, "children": [ { "id": 1281, "name": "indexName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the index" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 537, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L537" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1280, "name": "vectorBucketName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the vector bucket" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 536, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L536" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1282, "name": "vectors", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of vectors to insert/upsert (1-500 items)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 538, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L538" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1243, "name": "VectorObject", "package": "@supabase/storage-js" } } } ], "groups": [ { "title": "Properties", "children": [1281, 1280, 1282] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 535, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L535" } ] }, { "id": 1300, "name": "QueryVectorsOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for querying similar vectors (ANN search)" } ] }, "children": [ { "id": 1305, "name": "filter", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional JSON filter for metadata" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 607, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L607" } ], "type": { "type": "reference", "target": 1299, "name": "VectorFilter", "package": "@supabase/storage-js" } }, { "id": 1302, "name": "indexName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the index" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 604, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L604" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1303, "name": "queryVector", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Query vector to find similar vectors" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 605, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L605" } ], "type": { "type": "reference", "target": 1240, "name": "VectorData", "package": "@supabase/storage-js" } }, { "id": 1306, "name": "returnDistance", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to include distance scores" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 608, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L608" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1307, "name": "returnMetadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to include metadata in results" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 609, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L609" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1304, "name": "topK", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of nearest neighbors to return (default: 10)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 606, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L606" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1301, "name": "vectorBucketName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the vector bucket" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 603, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L603" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1305, 1302, 1303, 1306, 1307, 1304, 1301] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 602, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L602" } ] }, { "id": 1308, "name": "QueryVectorsResponse", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response from vector similarity query" } ] }, "children": [ { "id": 1310, "name": "distanceMetric", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The distance metric used for the similarity search" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 619, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L619" } ], "type": { "type": "reference", "target": 1231, "name": "DistanceMetric", "package": "@supabase/storage-js" } }, { "id": 1309, "name": "vectors", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of similar vectors ordered by distance" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 618, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L618" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1247, "name": "VectorMatch", "package": "@supabase/storage-js" } } } ], "groups": [ { "title": "Properties", "children": [1310, 1309] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 617, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L617" } ] }, { "id": 1170, "name": "SearchOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1171, "name": "limit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The number of files you want to be returned." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n100\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 184, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L184" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1172, "name": "offset", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The starting position." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 189, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L189" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1174, "name": "search", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The search string to filter files by." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 199, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L199" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1173, "name": "sortBy", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The column to sort by. Can be any column inside a FileObject." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 194, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L194" } ], "type": { "type": "reference", "target": 1158, "name": "SortBy", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [1171, 1172, 1174, 1173] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 179, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L179" } ] }, { "id": 1192, "name": "SearchV2Folder", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Folder entry returned by the List V2 API (listV2() method) when using with_delimiter: true" } ] }, "children": [ { "id": 1194, "name": "key", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Full folder key/path" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 271, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L271" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1193, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Folder name/prefix" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 269, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L269" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1194, 1193] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 267, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L267" } ] }, { "id": 1184, "name": "SearchV2Object", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "File object returned by the List V2 API (listV2() method)\nObjects and folders are returned in separate arrays - this type represents\nactual files only. Use SearchV2Folder for folder entries." } ] }, "children": [ { "id": 1189, "name": "created_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creation timestamp" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 257, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L257" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1187, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique identifier for the file" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 253, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L253" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1186, "name": "key", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Full object key/path" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 251, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L251" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1191, "name": "last_accessed_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Last access timestamp" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 261, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L261" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1190, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "File metadata including size, mimetype, etc. (null if not yet set)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 259, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L259" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": 1125, "name": "FileMetadata", "package": "@supabase/storage-js" } ] } }, { "id": 1185, "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "File name" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 249, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L249" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1188, "name": "updated_at", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Last update timestamp" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 255, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L255" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1189, 1187, 1186, 1191, 1190, 1185, 1188] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 247, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L247" } ] }, { "id": 1178, "name": "SearchV2Options", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1181, "name": "cursor", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The cursor used for pagination. Pass the value received from nextCursor of the previous request." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 222, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L222" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1179, "name": "limit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The number of files you want to be returned." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n1000\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 212, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L212" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1180, "name": "prefix", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The prefix search string to filter files by." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 217, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L217" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1183, "name": "sortBy", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The column and order to sort by" } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\n'name asc'\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 239, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L239" } ], "type": { "type": "reference", "target": 1175, "name": "SortByV2", "package": "@supabase/storage-js" } }, { "id": 1182, "name": "with_delimiter", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Whether to emulate a hierarchical listing of objects using delimiters.\n\n- When " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " (default), all objects are listed as flat key/value pairs.\n- When " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", the response groups objects by delimiter, making it appear\n like a file/folder hierarchy." } ], "blockTags": [ { "tag": "@default", "content": [ { "kind": "code", "text": "```ts\nfalse\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 233, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L233" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [1181, 1179, 1180, 1183, 1182] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 207, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L207" } ] }, { "id": 1195, "name": "SearchV2Result", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1197, "name": "folders", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 276, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L276" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1192, "name": "SearchV2Folder", "package": "@supabase/storage-js" } } }, { "id": 1196, "name": "hasNext", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 275, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L275" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 1199, "name": "nextCursor", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 278, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L278" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1198, "name": "objects", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 277, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L277" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1184, "name": "SearchV2Object", "package": "@supabase/storage-js" } } } ], "groups": [ { "title": "Properties", "children": [1197, 1196, 1199, 1198] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 274, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L274" } ] }, { "id": 1158, "name": "SortBy", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1159, "name": "column", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 142, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L142" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1160, "name": "order", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 143, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L143" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1159, 1160] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 141, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L141" } ] }, { "id": 1175, "name": "SortByV2", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1176, "name": "column", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 203, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L203" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "name" }, { "type": "literal", "value": "created_at" }, { "type": "literal", "value": "updated_at" } ] } }, { "id": 1177, "name": "order", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 204, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L204" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "asc" }, { "type": "literal", "value": "desc" } ] } } ], "groups": [ { "title": "Properties", "children": [1176, 1177] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 202, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L202" } ] }, { "id": 1091, "name": "StorageClientOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1092, "name": "useNewHostname", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 8, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L8" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [1092] } ], "sources": [ { "fileName": "packages/core/storage-js/src/StorageClient.ts", "line": 7, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/StorageClient.ts#L7" } ] }, { "id": 1313, "name": "SuccessResponse", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Standard response wrapper for successful operations" } ] }, "children": [ { "id": 1314, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Response data of type T" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 636, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L636" } ], "type": { "type": "reference", "target": 1316, "name": "T", "package": "@supabase/storage-js", "qualifiedName": "SuccessResponse.T", "refersToTypeParameter": true } }, { "id": 1315, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Null on success" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 637, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L637" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1314, 1315] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 635, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L635" } ], "typeParameters": [ { "id": 1316, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ] }, { "id": 1205, "name": "TransformOptions", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 1210, "name": "format", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Specify the format of the image requested.\n\nWhen using 'origin' we force the format to be the same as the original image.\nWhen this option is not passed in, images are optimized to modern image formats like Webp." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 332, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L332" } ], "type": { "type": "literal", "value": "origin" } }, { "id": 1207, "name": "height", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The height of the image in pixels." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 312, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L312" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1209, "name": "quality", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 325, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L325" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1208, "name": "resize", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The resize mode can be cover, contain or fill. Defaults to cover.\nCover resizes the image to maintain it's aspect ratio while filling the entire width and height.\nContain resizes the image to maintain it's aspect ratio while fitting the entire image within the width and height.\nFill 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." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 319, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L319" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "cover" }, { "type": "literal", "value": "contain" }, { "type": "literal", "value": "fill" } ] } }, { "id": 1206, "name": "width", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The width of the image in pixels." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 308, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L308" } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [1210, 1207, 1209, 1208, 1206] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 304, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L304" } ] }, { "id": 1224, "name": "VectorBucket", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Vector bucket metadata" } ] }, "children": [ { "id": 1226, "name": "creationTime", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Unix timestamp of when the bucket was created" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 374, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L374" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1227, "name": "encryptionConfiguration", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional encryption settings" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 375, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L375" } ], "type": { "type": "reference", "target": 1221, "name": "EncryptionConfiguration", "package": "@supabase/storage-js" } }, { "id": 1225, "name": "vectorBucketName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique name of the vector bucket" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 373, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L373" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1226, 1227, 1225] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 372, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L372" } ] }, { "id": 1240, "name": "VectorData", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Vector data representation\nVectors must be float32 arrays with dimensions matching the index" } ] }, "children": [ { "id": 1241, "name": "float32", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Array of 32-bit floating point numbers" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 424, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L424" } ], "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "number" } } } ], "groups": [ { "title": "Properties", "children": [1241] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 423, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L423" } ] }, { "id": 1311, "name": "VectorFetchParameters", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Fetch-specific parameters like abort signals" } ] }, "children": [ { "id": 1312, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "AbortSignal for cancelling requests" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 627, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L627" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" } } ], "groups": [ { "title": "Properties", "children": [1312] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 626, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L626" } ] }, { "id": 1232, "name": "VectorIndex", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Vector index configuration and metadata" } ] }, "children": [ { "id": 1239, "name": "creationTime", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Unix timestamp of when the index was created" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 415, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L415" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1235, "name": "dataType", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Data type of vector components (currently only 'float32')" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 411, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L411" } ], "type": { "type": "literal", "value": "float32" } }, { "id": 1236, "name": "dimension", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Dimensionality of vectors (e.g., 384, 768, 1536)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 412, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L412" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1237, "name": "distanceMetric", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Similarity metric used for queries" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 413, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L413" } ], "type": { "type": "reference", "target": 1231, "name": "DistanceMetric", "package": "@supabase/storage-js" } }, { "id": 1233, "name": "indexName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique name of the index within the bucket" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 409, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L409" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1238, "name": "metadataConfiguration", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Configuration for metadata filtering" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 414, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L414" } ], "type": { "type": "reference", "target": 1228, "name": "MetadataConfiguration", "package": "@supabase/storage-js" } }, { "id": 1234, "name": "vectorBucketName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the parent vector bucket" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 410, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L410" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [1239, 1235, 1236, 1237, 1233, 1238, 1234] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 408, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L408" } ] }, { "id": 1247, "name": "VectorMatch", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Vector object returned from queries with optional distance" } ] }, "children": [ { "id": 1249, "name": "data", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Vector embedding data (if requested)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 454, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L454" } ], "type": { "type": "reference", "target": 1240, "name": "VectorData", "package": "@supabase/storage-js" } }, { "id": 1251, "name": "distance", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Similarity distance from query vector (if requested)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 456, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L456" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1248, "name": "key", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique identifier for the vector" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 453, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L453" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1250, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Arbitrary metadata (if requested)" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 455, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L455" } ], "type": { "type": "reference", "target": 1242, "name": "VectorMetadata", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [1249, 1251, 1248, 1250] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 452, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L452" } ] }, { "id": 1243, "name": "VectorObject", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Single vector object for insertion/update" } ] }, "children": [ { "id": 1245, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Vector embedding data" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 441, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L441" } ], "type": { "type": "reference", "target": 1240, "name": "VectorData", "package": "@supabase/storage-js" } }, { "id": 1244, "name": "key", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique identifier for the vector" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 440, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L440" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1246, "name": "metadata", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional arbitrary metadata" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 442, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L442" } ], "type": { "type": "reference", "target": 1242, "name": "VectorMetadata", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [1245, 1244, 1246] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 439, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L439" } ] }, { "id": 1320, "name": "ApiResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Union type for all API responses\nFollows the pattern: { data: T, error: null } | { data: null, error: Error }" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 654, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L654" } ], "typeParameters": [ { "id": 1321, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 1313, "typeArguments": [ { "type": "reference", "target": 1321, "name": "T", "package": "@supabase/storage-js", "refersToTypeParameter": true } ], "name": "SuccessResponse", "package": "@supabase/storage-js" }, { "type": "reference", "target": 1317, "name": "ErrorResponse", "package": "@supabase/storage-js" } ] } }, { "id": 1102, "name": "BucketType", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Type of storage bucket\n- STANDARD: Regular file storage buckets\n- ANALYTICS: Iceberg table-based buckets for analytical workloads" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 8, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L8" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "STANDARD" }, { "type": "literal", "value": "ANALYTICS" } ] } }, { "id": 1211, "name": "Camelize", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 339, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L339" } ], "typeParameters": [ { "id": 1212, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "type": { "type": "mapped", "parameter": "K", "parameterType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": 1212, "name": "T", "package": "@supabase/storage-js", "refersToTypeParameter": true } }, "templateType": { "type": "indexedAccess", "indexType": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "K" }, "name": "K", "package": "@supabase/storage-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 1212, "name": "T", "package": "@supabase/storage-js", "refersToTypeParameter": true } }, "nameType": { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "CamelCase" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Extract" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "K" }, "name": "K", "package": "@supabase/storage-js", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "string" } ], "name": "Extract", "package": "typescript" } ], "name": "CamelCase", "package": "@supabase/storage-js" } } }, { "id": 1231, "name": "DistanceMetric", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Distance metrics for vector similarity search" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 396, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L396" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "cosine" }, { "type": "literal", "value": "euclidean" }, { "type": "literal", "value": "dotproduct" } ] } }, { "id": 1213, "name": "DownloadResult", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 343, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L343" } ], "typeParameters": [ { "id": 1220, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "type": { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 1214, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1215, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 345, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L345" } ], "type": { "type": "reference", "target": 1220, "name": "T", "package": "@supabase/storage-js", "refersToTypeParameter": true } }, { "id": 1216, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 346, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L346" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [1215, 1216] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 344, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L344" } ] } }, { "type": "reflection", "declaration": { "id": 1217, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 1218, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 349, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L349" } ], "type": { "type": "literal", "value": null } }, { "id": 1219, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 350, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L350" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [1218, 1219] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 348, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L348" } ] } } ] } }, { "id": 1328, "name": "ErrorNamespace", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Namespace type for error classes\nDetermines the error class names and type guards" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 5, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L5" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "storage" }, { "type": "literal", "value": "vectors" } ] } }, { "id": 1230, "name": "VectorDataType", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Supported data types for vectors\nCurrently only float32 is supported" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 391, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L391" } ], "type": { "type": "literal", "value": "float32" } }, { "id": 1299, "name": "VectorFilter", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "JSON filter expression for metadata filtering\nFormat and syntax depend on the S3 Vectors service implementation" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 590, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L590" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } }, { "id": 1242, "name": "VectorMetadata", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Arbitrary JSON metadata attached to vectors\nKeys configured as non-filterable in the index can be stored but not queried" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/types.ts", "line": 431, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/types.ts#L431" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "any" } ], "name": "Record", "package": "typescript" } }, { "id": 1322, "name": "isStorageError", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 36, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L36" } ], "signatures": [ { "id": 1323, "name": "isStorageError", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Type guard to check if an error is a StorageError" } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "True if the error is a StorageError" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 36, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L36" } ], "parameters": [ { "id": 1324, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The error to check" } ] }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } } ] }, { "id": 1325, "name": "isStorageVectorsError", "variant": "declaration", "kind": 64, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 103, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L103" } ], "signatures": [ { "id": 1326, "name": "isStorageVectorsError", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Type guard to check if an error is a StorageVectorsError" } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "True if the error is a StorageVectorsError" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/errors.ts", "line": 103, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/errors.ts#L103" } ], "parameters": [ { "id": 1327, "name": "error", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The error to check" } ] }, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "predicate", "name": "error", "asserts": false, "targetType": { "type": "reference", "target": 1369, "name": "StorageVectorsError", "package": "@supabase/storage-js" } } } ] }, { "id": 1101, "name": "CreateIndexOptions", "variant": "reference", "kind": 4194304, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/index.ts", "line": 15, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/index.ts#L15" } ], "target": 891 }, { "id": 1093, "name": "StorageAnalyticsClient", "variant": "reference", "kind": 4194304, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/index.ts", "line": 3, "character": 20, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/index.ts#L3" } ], "target": 48 }, { "id": 1094, "name": "StorageVectorsClient", "variant": "reference", "kind": 4194304, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/index.ts", "line": 7, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/index.ts#L7" } ], "target": 544 }, { "id": 1097, "name": "StorageVectorsClientOptions", "variant": "reference", "kind": 4194304, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/index.ts", "line": 11, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/index.ts#L11" } ], "target": 531 }, { "id": 1095, "name": "VectorBucketScope", "variant": "reference", "kind": 4194304, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/index.ts", "line": 8, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/index.ts#L8" } ], "target": 599 }, { "id": 1096, "name": "VectorIndexScope", "variant": "reference", "kind": 4194304, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/index.ts", "line": 9, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/index.ts#L9" } ], "target": 667 } ], "groups": [ { "title": "Enumerations", "children": [1404] }, { "title": "Classes", "children": [1340, 963, 1329, 1358, 1377, 1369, 1394] }, { "title": "Interfaces", "children": [ 1119, 1103, 1283, 1168, 1221, 1317, 1200, 1125, 1135, 1145, 1161, 1271, 1277, 1113, 1261, 1266, 1252, 1256, 1287, 1296, 1203, 1228, 1279, 1300, 1308, 1170, 1192, 1184, 1178, 1195, 1158, 1175, 1091, 1313, 1205, 1224, 1240, 1311, 1232, 1247, 1243 ] }, { "title": "Type Aliases", "children": [1320, 1102, 1211, 1231, 1213, 1328, 1230, 1299, 1242] }, { "title": "Functions", "children": [1322, 1325] }, { "title": "References", "children": [1101, 1093, 1094, 1097, 1095, 1096] } ], "sources": [ { "fileName": "packages/core/storage-js/src/index.ts", "line": 1, "character": 0, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/index.ts#L1" } ] }, { "id": 2, "name": "packages/BlobDownloadBuilder", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { "id": 3, "name": "default", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { "id": 4, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 9, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L9" } ], "signatures": [ { "id": 5, "name": "default", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 9, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L9" } ], "parameters": [ { "id": 6, "name": "downloadFn", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 7, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 10, "character": 24, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L10" } ], "signatures": [ { "id": 8, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 10, "character": 24, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L10" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 9, "name": "shouldThrowOnError", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "boolean" } } ], "type": { "type": "reference", "target": 3, "name": "BlobDownloadBuilder", "package": "@supabase/storage-js", "qualifiedName": "default" } } ] }, { "id": 45, "name": "[toStringTag]", "variant": "declaration", "kind": 1024, "flags": { "isReadonly": true }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 6, "character": 11, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L6" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "'BlobDownloadBuilder'", "implementationOf": { "type": "reference", "target": -1, "name": "Promise.[toStringTag]" } }, { "id": 15, "name": "asStream", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 14, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L14" } ], "signatures": [ { "id": 16, "name": "asStream", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 14, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L14" } ], "type": { "type": "reference", "target": 736, "name": "StreamDownloadBuilder", "package": "@supabase/storage-js", "qualifiedName": "default" } } ] }, { "id": 29, "name": "catch", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 25, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L25" } ], "signatures": [ { "id": 30, "name": "catch", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Attaches a callback for only the rejection of the Promise." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A Promise for the completion of the callback." } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 25, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L25" } ], "typeParameters": [ { "id": 31, "name": "TResult", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 32, "name": "onrejected", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The callback to execute when the Promise is rejected." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 33, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 26, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L26" } ], "signatures": [ { "id": 34, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 26, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L26" } ], "parameters": [ { "id": 35, "name": "reason", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 31, "name": "TResult", "package": "@supabase/storage-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 31, "name": "TResult", "package": "@supabase/storage-js", "refersToTypeParameter": true } ], "name": "PromiseLike", "package": "typescript" } ] } } ] } } ] } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": 1213, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Blob" }, "name": "Blob", "package": "typescript" } ], "name": "DownloadResult", "package": "@supabase/storage-js" }, { "type": "reference", "target": 31, "name": "TResult", "package": "@supabase/storage-js", "refersToTypeParameter": true } ] } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": -1, "name": "Promise.catch" } } ], "implementationOf": { "type": "reference", "target": -1, "name": "Promise.catch" } }, { "id": 36, "name": "finally", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 31, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" } ], "signatures": [ { "id": 37, "name": "finally", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The\nresolved value cannot be modified from the callback." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A Promise for the completion of the callback." } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 31, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" } ], "parameters": [ { "id": 38, "name": "onfinally", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The callback to execute when the Promise is settled (fulfilled or rejected)." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 39, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 31, "character": 23, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" } ], "signatures": [ { "id": 40, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 31, "character": 23, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31" } ], "type": { "type": "intrinsic", "name": "void" } } ] } } ] } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1213, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Blob" }, "name": "Blob", "package": "typescript" } ], "name": "DownloadResult", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": -1, "name": "Promise.finally" } } ], "implementationOf": { "type": "reference", "target": -1, "name": "Promise.finally" } }, { "id": 17, "name": "then", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 18, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L18" } ], "signatures": [ { "id": 18, "name": "then", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Attaches callbacks for the resolution and/or rejection of the Promise." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A Promise for the completion of which ever callback is executed." } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 18, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L18" } ], "typeParameters": [ { "id": 19, "name": "TResult1", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 1213, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Blob" }, "name": "Blob", "package": "typescript" } ], "name": "DownloadResult", "package": "@supabase/storage-js" } }, { "id": 20, "name": "TResult2", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 21, "name": "onfulfilled", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The callback to execute when the Promise is resolved." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 22, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 19, "character": 19, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L19" } ], "signatures": [ { "id": 23, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 19, "character": 19, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L19" } ], "parameters": [ { "id": 24, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1213, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Blob" }, "name": "Blob", "package": "typescript" } ], "name": "DownloadResult", "package": "@supabase/storage-js" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 19, "name": "TResult1", "package": "@supabase/storage-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 19, "name": "TResult1", "package": "@supabase/storage-js", "refersToTypeParameter": true } ], "name": "PromiseLike", "package": "typescript" } ] } } ] } } ] } }, { "id": 25, "name": "onrejected", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The callback to execute when the Promise is rejected." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 26, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 20, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L20" } ], "signatures": [ { "id": 27, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 20, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L20" } ], "parameters": [ { "id": 28, "name": "reason", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 20, "name": "TResult2", "package": "@supabase/storage-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 20, "name": "TResult2", "package": "@supabase/storage-js", "refersToTypeParameter": true } ], "name": "PromiseLike", "package": "typescript" } ] } } ] } } ] } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": 19, "name": "TResult1", "package": "@supabase/storage-js", "refersToTypeParameter": true }, { "type": "reference", "target": 20, "name": "TResult2", "package": "@supabase/storage-js", "refersToTypeParameter": true } ] } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": -1, "name": "Promise.then" } } ], "implementationOf": { "type": "reference", "target": -1, "name": "Promise.then" } } ], "groups": [ { "title": "Constructors", "children": [4] }, { "title": "Properties", "children": [45] }, { "title": "Methods", "children": [15, 29, 36, 17] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 5, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L5" } ], "implementedTypes": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1213, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Blob" }, "name": "Blob", "package": "typescript" } ], "name": "DownloadResult", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" } ] } ], "groups": [ { "title": "Classes", "children": [3] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts", "line": 1, "character": 0, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L1" } ] }, { "id": 46, "name": "packages/StorageAnalyticsClient", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { "id": 48, "name": "default", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Client class for managing Analytics Buckets using Iceberg tables\nProvides methods for creating, listing, and deleting analytics buckets" } ] }, "children": [ { "id": 49, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 39, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L39" } ], "signatures": [ { "id": 50, "name": "default", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a new StorageAnalyticsClient instance\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Analytics Buckets" } ] }, { "tag": "@example", "name": "Creating a StorageAnalyticsClient instance", "content": [ { "kind": "code", "text": "```typescript\nconst client = new StorageAnalyticsClient(url, headers)\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 39, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L39" } ], "parameters": [ { "id": 51, "name": "url", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The base URL for the storage API" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 52, "name": "headers", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "HTTP headers to include in requests" } ] }, "type": { "type": "reflection", "declaration": { "id": 53, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 39, "character": 36, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L39" } ], "indexSignatures": [ { "id": 54, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 39, "character": 38, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L39" } ], "parameters": [ { "id": 55, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } }, "defaultValue": "{}" }, { "id": 56, "name": "fetch", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional custom fetch implementation" } ] }, "type": { "type": "reflection", "declaration": { "id": 57, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 58, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 59, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 60, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 61, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 62, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 63, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } } ], "type": { "type": "reference", "target": 48, "name": "StorageAnalyticsClient", "package": "@supabase/storage-js", "qualifiedName": "default" }, "overwrites": { "type": "reference", "target": -1, "name": "BaseApiClient.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "BaseApiClient.constructor" } }, { "id": 64, "name": "createBucket", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 83, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L83" } ], "signatures": [ { "id": 65, "name": "createBucket", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a new analytics bucket using Iceberg tables\nAnalytics buckets are optimized for analytical queries and data processing\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Analytics Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing newly created analytics bucket or error" } ] }, { "tag": "@example", "name": "Create analytics bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .createBucket('analytics-data')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"name\": \"analytics-data\",\n \"type\": \"ANALYTICS\",\n \"format\": \"iceberg\",\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Creates a new analytics bucket using Iceberg tables\n- Analytics buckets are optimized for analytical queries and data processing" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 83, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L83" } ], "parameters": [ { "id": 66, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A unique name for the bucket you are creating" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 67, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 68, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 85, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L85" } ], "type": { "type": "reference", "target": 1119, "name": "AnalyticBucket", "package": "@supabase/storage-js" } }, { "id": 69, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 86, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L86" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [68, 69] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 84, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L84" } ] } }, { "type": "reflection", "declaration": { "id": 70, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 71, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 89, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L89" } ], "type": { "type": "literal", "value": null } }, { "id": 72, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 90, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L90" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [71, 72] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 88, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L88" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 88, "name": "deleteBucket", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 214, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L214" } ], "signatures": [ { "id": 89, "name": "deleteBucket", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Deletes an existing analytics bucket\nA bucket can't be deleted with existing objects inside it\nYou must first empty the bucket before deletion\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Analytics Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing success message or error" } ] }, { "tag": "@example", "name": "Delete analytics bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .deleteBucket('analytics-data')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Deletes an analytics bucket" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 214, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L214" } ], "parameters": [ { "id": 90, "name": "bucketName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The unique identifier of the bucket you would like to delete" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 91, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 92, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 216, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L216" } ], "type": { "type": "reflection", "declaration": { "id": 93, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 94, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 216, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L216" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [94] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 216, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L216" } ] } } }, { "id": 95, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 217, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L217" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [92, 95] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 215, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L215" } ] } }, { "type": "reflection", "declaration": { "id": 96, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 97, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 220, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L220" } ], "type": { "type": "literal", "value": null } }, { "id": 98, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 221, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L221" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [97, 98] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 219, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L219" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 99, "name": "from", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 357, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L357" } ], "signatures": [ { "id": 100, "name": "from", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Get an Iceberg REST Catalog client configured for a specific analytics bucket\nUse this to perform advanced table and namespace operations within the bucket\nThe returned client provides full access to the Apache Iceberg REST Catalog API\nwith the Supabase " }, { "kind": "code", "text": "`{ data, error }`" }, { "kind": "text", "text": " pattern for consistent error handling on all operations.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Analytics Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "The wrapped Iceberg catalog client" } ] }, { "tag": "@throws", "content": [ { "kind": "text", "text": "If the bucket name is invalid" } ] }, { "tag": "@example", "name": "Get catalog and create table", "content": [ { "kind": "code", "text": "```js\n// First, create an analytics bucket\nconst { data: bucket, error: bucketError } = await supabase\n .storage\n .analytics\n .createBucket('analytics-data')\n\n// Get the Iceberg catalog for that bucket\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// Create a namespace\nconst { error: nsError } = await catalog.createNamespace({ namespace: ['default'] })\n\n// Create a table with schema\nconst { data: tableMetadata, error: tableError } = await catalog.createTable(\n { namespace: ['default'] },\n {\n name: 'events',\n schema: {\n type: 'struct',\n fields: [\n { id: 1, name: 'id', type: 'long', required: true },\n { id: 2, name: 'timestamp', type: 'timestamp', required: true },\n { id: 3, name: 'user_id', type: 'string', required: false }\n ],\n 'schema-id': 0,\n 'identifier-field-ids': [1]\n },\n 'partition-spec': {\n 'spec-id': 0,\n fields: []\n },\n 'write-order': {\n 'order-id': 0,\n fields: []\n },\n properties: {\n 'write.format.default': 'parquet'\n }\n }\n)\n```" } ] }, { "tag": "@example", "name": "List tables in namespace", "content": [ { "kind": "code", "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// List all tables in the default namespace\nconst { data: tables, error: listError } = await catalog.listTables({ namespace: ['default'] })\nif (listError) {\n if (listError.isNotFound()) {\n console.log('Namespace not found')\n }\n return\n}\nconsole.log(tables) // [{ namespace: ['default'], name: 'events' }]\n```" } ] }, { "tag": "@example", "name": "Working with namespaces", "content": [ { "kind": "code", "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// List all namespaces\nconst { data: namespaces } = await catalog.listNamespaces()\n\n// Create namespace with properties\nawait catalog.createNamespace(\n { namespace: ['production'] },\n { properties: { owner: 'data-team', env: 'prod' } }\n)\n```" } ] }, { "tag": "@example", "name": "Cleanup operations", "content": [ { "kind": "code", "text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// Drop table with purge option (removes all data)\nconst { error: dropError } = await catalog.dropTable(\n { namespace: ['default'], name: 'events' },\n { purge: true }\n)\n\nif (dropError?.isNotFound()) {\n console.log('Table does not exist')\n}\n\n// Drop namespace (must be empty)\nawait catalog.dropNamespace({ namespace: ['default'] })\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "This method provides a bridge between Supabase's bucket management and the standard\nApache Iceberg REST Catalog API. The bucket name maps to the Iceberg warehouse parameter.\nAll authentication and configuration is handled automatically using your Supabase credentials.\n\n**Error Handling**: Invalid bucket names throw immediately. All catalog\noperations return " }, { "kind": "code", "text": "`{ data, error }`" }, { "kind": "text", "text": " where errors are " }, { "kind": "code", "text": "`IcebergError`" }, { "kind": "text", "text": " instances from iceberg-js.\nUse helper methods like " }, { "kind": "code", "text": "`error.isNotFound()`" }, { "kind": "text", "text": " or check " }, { "kind": "code", "text": "`error.status`" }, { "kind": "text", "text": " for specific error handling.\nUse " }, { "kind": "code", "text": "`.throwOnError()`" }, { "kind": "text", "text": " on the analytics client if you prefer exceptions for catalog operations.\n\n**Cleanup Operations**: When using " }, { "kind": "code", "text": "`dropTable`" }, { "kind": "text", "text": ", the " }, { "kind": "code", "text": "`purge: true`" }, { "kind": "text", "text": " option permanently\ndeletes all table data. Without it, the table is marked as deleted but data remains.\n\n**Library Dependency**: The returned catalog wraps " }, { "kind": "code", "text": "`IcebergRestCatalog`" }, { "kind": "text", "text": " from iceberg-js.\nFor complete API documentation and advanced usage, refer to the\n[iceberg-js documentation](https://supabase.github.io/iceberg-js/)." } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 357, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L357" } ], "parameters": [ { "id": 101, "name": "bucketName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The name of the analytics bucket (warehouse) to connect to" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 47, "name": "WrappedIcebergRestCatalog", "package": "@supabase/storage-js" } } ] }, { "id": 73, "name": "listBuckets", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 148, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L148" } ], "signatures": [ { "id": 74, "name": "listBuckets", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Retrieves the details of all Analytics Storage buckets within an existing project\nOnly returns buckets of type 'ANALYTICS'\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Analytics Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing array of analytics buckets or error" } ] }, { "tag": "@example", "name": "List analytics buckets", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc'\n })\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"analytics-data\",\n \"type\": \"ANALYTICS\",\n \"format\": \"iceberg\",\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n }\n ],\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Retrieves the details of all Analytics Storage buckets within an existing project\n- Only returns buckets of type 'ANALYTICS'" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 148, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L148" } ], "parameters": [ { "id": 75, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Query parameters for listing buckets" } ] }, "type": { "type": "reflection", "declaration": { "id": 76, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 77, "name": "limit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Maximum number of buckets to return" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 149, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L149" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 78, "name": "offset", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Number of buckets to skip" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 150, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L150" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 81, "name": "search", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Search term to filter bucket names" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 153, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L153" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 79, "name": "sortColumn", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Column to sort by ('name', 'created_at', 'updated_at')" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 151, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L151" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "name" }, { "type": "literal", "value": "created_at" }, { "type": "literal", "value": "updated_at" } ] } }, { "id": 80, "name": "sortOrder", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Sort order ('asc' or 'desc')" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 152, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L152" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "asc" }, { "type": "literal", "value": "desc" } ] } } ], "groups": [ { "title": "Properties", "children": [77, 78, 81, 79, 80] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 148, "character": 30, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L148" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 82, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 83, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 156, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L156" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1119, "name": "AnalyticBucket", "package": "@supabase/storage-js" } } }, { "id": 84, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 157, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L157" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [83, 84] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 155, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L155" } ] } }, { "type": "reflection", "declaration": { "id": 85, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 86, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 160, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L160" } ], "type": { "type": "literal", "value": null } }, { "id": 87, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 161, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [86, 87] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 159, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L159" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 119, "name": "setHeader", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "signatures": [ { "id": 120, "name": "setHeader", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "parameters": [ { "id": 121, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 122, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header value" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.setHeader" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.setHeader" } }, { "id": 117, "name": "throwOnError", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "signatures": [ { "id": 118, "name": "throwOnError", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.throwOnError" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.throwOnError" } } ], "groups": [ { "title": "Constructors", "children": [49] }, { "title": "Methods", "children": [64, 88, 99, 73, 119, 117] } ], "categories": [ { "title": "Analytics Buckets", "children": [49, 64, 88, 99, 73] }, { "title": "Other", "children": [119, 117] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 21, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L21" } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default" }, "typeArguments": [ { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } ], "name": "default", "package": "@supabase/storage-js" } ] }, { "id": 47, "name": "WrappedIcebergRestCatalog", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 13, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L13" } ], "type": { "type": "mapped", "parameter": "K", "parameterType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/iceberg-js/dist/index.d.ts", "qualifiedName": "IcebergRestCatalog" }, "name": "IcebergRestCatalog", "package": "iceberg-js" } }, "templateType": { "type": "reference", "target": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "WrapAsyncMethod" }, "typeArguments": [ { "type": "indexedAccess", "indexType": { "type": "reference", "target": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "K" }, "name": "K", "package": "@supabase/storage-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/iceberg-js/dist/index.d.ts", "qualifiedName": "IcebergRestCatalog" }, "name": "IcebergRestCatalog", "package": "iceberg-js" } } ], "name": "WrapAsyncMethod", "package": "@supabase/storage-js" } } } ], "groups": [ { "title": "Classes", "children": [48] }, { "title": "Type Aliases", "children": [47] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts", "line": 1, "character": 0, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L1" } ] }, { "id": 135, "name": "packages/StorageBucketApi", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { "id": 136, "name": "default", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { "id": 137, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 9, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L9" } ], "signatures": [ { "id": 138, "name": "default", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 9, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L9" } ], "parameters": [ { "id": 139, "name": "url", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 140, "name": "headers", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 141, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 11, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L11" } ], "indexSignatures": [ { "id": 142, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 11, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L11" } ], "parameters": [ { "id": 143, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } }, "defaultValue": "{}" }, { "id": 144, "name": "fetch", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 145, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 146, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 147, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 148, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 149, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 150, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 151, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 152, "name": "opts", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 1091, "name": "StorageClientOptions", "package": "@supabase/storage-js" } } ], "type": { "type": "reference", "target": 136, "name": "StorageBucketApi", "package": "@supabase/storage-js", "qualifiedName": "default" }, "overwrites": { "type": "reference", "target": -1, "name": "BaseApiClient.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "BaseApiClient.constructor" } }, { "id": 171, "name": "createBucket", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 185, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L185" } ], "signatures": [ { "id": 172, "name": "createBucket", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a new Storage bucket" } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing newly created bucket name or error" } ] }, { "tag": "@example", "name": "Create bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .createBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"name\": \"avatars\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`insert`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 185, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L185" } ], "parameters": [ { "id": 173, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A unique identifier for the bucket you are creating." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 174, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 175, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 178, "name": "allowedMimeTypes", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 190, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L190" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] } }, { "id": 177, "name": "fileSizeLimit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 189, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L189" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 176, "name": "public", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 188, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 179, "name": "type", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "(private-beta) specifies the bucket type. see " }, { "kind": "code", "text": "`BucketType`" }, { "kind": "text", "text": " for more details.\n - default bucket type is " }, { "kind": "code", "text": "`STANDARD`" } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 191, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L191" } ], "type": { "type": "reference", "target": 1102, "name": "BucketType", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [178, 177, 176, 179] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 187, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L187" } ] } }, "defaultValue": "..." } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 180, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 181, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 197, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L197" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Pick" }, "typeArguments": [ { "type": "reference", "target": 1103, "name": "Bucket", "package": "@supabase/storage-js" }, { "type": "literal", "value": "name" } ], "name": "Pick", "package": "typescript" } }, { "id": 182, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 198, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L198" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [181, 182] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 196, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L196" } ] } }, { "type": "reflection", "declaration": { "id": 183, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 184, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 201, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201" } ], "type": { "type": "literal", "value": null } }, { "id": 185, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 202, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L202" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [184, 185] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 200, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L200" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 213, "name": "deleteBucket", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 372, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L372" } ], "signatures": [ { "id": 214, "name": "deleteBucket", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first " }, { "kind": "code", "text": "`empty()`" }, { "kind": "text", "text": " the bucket." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with success message or error" } ] }, { "tag": "@example", "name": "Delete bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .deleteBucket('avatars')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`delete`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 372, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L372" } ], "parameters": [ { "id": 215, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The unique identifier of the bucket you would like to delete." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 216, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 217, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 374, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L374" } ], "type": { "type": "reflection", "declaration": { "id": 218, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 219, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 374, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L374" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [219] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 374, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L374" } ] } } }, { "id": 220, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 375, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L375" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [217, 220] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 373, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L373" } ] } }, { "type": "reflection", "declaration": { "id": 221, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 222, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 378, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378" } ], "type": { "type": "literal", "value": null } }, { "id": 223, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 379, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L379" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [222, 223] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 377, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L377" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 202, "name": "emptyBucket", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 326, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L326" } ], "signatures": [ { "id": 203, "name": "emptyBucket", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Removes all objects inside a single bucket." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with success message or error" } ] }, { "tag": "@example", "name": "Empty bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .emptyBucket('avatars')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully emptied\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`delete`" }, { "kind": "text", "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 326, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L326" } ], "parameters": [ { "id": 204, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The unique identifier of the bucket you would like to empty." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 205, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 206, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 328, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L328" } ], "type": { "type": "reflection", "declaration": { "id": 207, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 208, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 328, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L328" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [208] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 328, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L328" } ] } } }, { "id": 209, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 329, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L329" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [206, 209] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 327, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L327" } ] } }, { "type": "reflection", "declaration": { "id": 210, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 211, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 332, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L332" } ], "type": { "type": "literal", "value": null } }, { "id": 212, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 333, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [211, 212] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 331, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 162, "name": "getBucket", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 127, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L127" } ], "signatures": [ { "id": 163, "name": "getBucket", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Retrieves the details of an existing Storage bucket." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing bucket details or error" } ] }, { "tag": "@example", "name": "Get bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .getBucket('avatars')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"id\": \"avatars\",\n \"name\": \"avatars\",\n \"owner\": \"\",\n \"public\": false,\n \"file_size_limit\": 1024,\n \"allowed_mime_types\": [\n \"image/png\"\n ],\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 127, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L127" } ], "parameters": [ { "id": 164, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The unique identifier of the bucket you would like to retrieve." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 165, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 166, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 129, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129" } ], "type": { "type": "reference", "target": 1103, "name": "Bucket", "package": "@supabase/storage-js" } }, { "id": 167, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 130, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L130" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [166, 167] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 128, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L128" } ] } }, { "type": "reflection", "declaration": { "id": 168, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 169, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 133, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L133" } ], "type": { "type": "literal", "value": null } }, { "id": 170, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 134, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L134" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [169, 170] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 132, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L132" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 153, "name": "listBuckets", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 70, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L70" } ], "signatures": [ { "id": 154, "name": "listBuckets", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Retrieves the details of all Storage buckets within an existing project." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing array of buckets or error" } ] }, { "tag": "@example", "name": "List buckets", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets()\n```" } ] }, { "tag": "@example", "name": "List buckets with options", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod'\n })\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 70, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L70" } ], "parameters": [ { "id": 155, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Query parameters for listing buckets" } ] }, "type": { "type": "reference", "target": 1113, "name": "ListBucketOptions", "package": "@supabase/storage-js", "highlightedProperties": { "limit": [ { "kind": "text", "text": "Maximum number of buckets to return" } ], "offset": [ { "kind": "text", "text": "Number of buckets to skip" } ], "sortColumn": [ { "kind": "text", "text": "Column to sort by ('id', 'name', 'created_at', 'updated_at')" } ], "sortOrder": [ { "kind": "text", "text": "Sort order ('asc' or 'desc')" } ], "search": [ { "kind": "text", "text": "Search term to filter bucket names" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 156, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 157, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 72, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L72" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1103, "name": "Bucket", "package": "@supabase/storage-js" } } }, { "id": 158, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 73, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L73" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [157, 158] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 71, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71" } ] } }, { "type": "reflection", "declaration": { "id": 159, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 160, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 76, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L76" } ], "type": { "type": "literal", "value": null } }, { "id": 161, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 77, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L77" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [160, 161] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 75, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L75" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 244, "name": "setHeader", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "signatures": [ { "id": 245, "name": "setHeader", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "parameters": [ { "id": 246, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 247, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header value" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.setHeader" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.setHeader" } }, { "id": 242, "name": "throwOnError", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "signatures": [ { "id": 243, "name": "throwOnError", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.throwOnError" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.throwOnError" } }, { "id": 186, "name": "updateBucket", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 263, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L263" } ], "signatures": [ { "id": 187, "name": "updateBucket", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Updates a Storage bucket" } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing success message or error" } ] }, { "tag": "@example", "name": "Update bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .updateBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully updated\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`update`" }, { "kind": "text", "text": "\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 263, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L263" } ], "parameters": [ { "id": 188, "name": "id", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A unique identifier for the bucket you are updating." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 189, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 190, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 193, "name": "allowedMimeTypes", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "specifies the allowed mime types that this bucket can accept during upload.\nThe default value is null, which allows files with all mime types to be uploaded.\nEach mime type specified can be a wildcard, e.g. image/*, or a specific mime type, e.g. image/png." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 268, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L268" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } ] } }, { "id": 192, "name": "fileSizeLimit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "specifies the max file size in bytes that can be uploaded to this bucket.\nThe global file size limit takes precedence over this value.\nThe default value is null, which doesn't set a per bucket file size limit." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 267, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 191, "name": "public", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 266, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L266" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [193, 192, 191] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 265, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L265" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 194, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 195, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 272, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" } ], "type": { "type": "reflection", "declaration": { "id": 196, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 197, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 272, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [197] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 272, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272" } ] } } }, { "id": 198, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 273, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L273" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [195, 198] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 271, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L271" } ] } }, { "type": "reflection", "declaration": { "id": 199, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 200, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 276, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276" } ], "type": { "type": "literal", "value": null } }, { "id": 201, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 277, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L277" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [200, 201] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 275, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L275" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Constructors", "children": [137] }, { "title": "Methods", "children": [171, 213, 202, 162, 153, 244, 242, 186] } ], "categories": [ { "title": "File Buckets", "children": [171, 213, 202, 162, 153, 186] }, { "title": "Other", "children": [137, 244, 242] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 8, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L8" } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default" }, "typeArguments": [ { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } ], "name": "default", "package": "@supabase/storage-js" } ], "extendedBy": [ { "type": "reference", "target": 963, "name": "StorageClient" } ] } ], "groups": [ { "title": "Classes", "children": [136] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts", "line": 1, "character": 0, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageBucketApi.ts#L1" } ] }, { "id": 260, "name": "packages/StorageFileApi", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { "id": 261, "name": "default", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { "id": 262, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 54, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L54" } ], "signatures": [ { "id": 263, "name": "default", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 54, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L54" } ], "parameters": [ { "id": 264, "name": "url", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 265, "name": "headers", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 266, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 56, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L56" } ], "indexSignatures": [ { "id": 267, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 56, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L56" } ], "parameters": [ { "id": 268, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } }, "defaultValue": "{}" }, { "id": 269, "name": "bucketId", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 270, "name": "fetch", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 271, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 272, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 273, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 274, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 275, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 276, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 277, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } } ], "type": { "type": "reference", "target": 261, "name": "StorageFileApi", "package": "@supabase/storage-js", "qualifiedName": "default" }, "overwrites": { "type": "reference", "target": -1, "name": "BaseApiClient.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "BaseApiClient.constructor" } }, { "id": 369, "name": "copy", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 543, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L543" } ], "signatures": [ { "id": 370, "name": "copy", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Copies an existing file to a new path in the same bucket." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing copied file path or error" } ] }, { "tag": "@example", "name": "Copy file", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .copy('public/avatar1.png', 'private/avatar2.png')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"path\": \"avatars/private/avatar2.png\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`insert`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 543, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L543" } ], "parameters": [ { "id": 371, "name": "fromPath", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The original file path, including the current file name. For example " }, { "kind": "code", "text": "`folder/image.png`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 372, "name": "toPath", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The new file path, including the new file name. For example " }, { "kind": "code", "text": "`folder/image-copy.png`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 373, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The destination options." } ] }, "type": { "type": "reference", "target": 1168, "name": "DestinationOptions", "package": "@supabase/storage-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 374, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 375, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 549, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L549" } ], "type": { "type": "reflection", "declaration": { "id": 376, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 377, "name": "path", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 549, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L549" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [377] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 549, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L549" } ] } } }, { "id": 378, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 550, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L550" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [375, 378] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 548, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L548" } ] } }, { "type": "reflection", "declaration": { "id": 379, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 380, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 553, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L553" } ], "type": { "type": "literal", "value": null } }, { "id": 381, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 554, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L554" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [380, 381] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 552, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L552" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 325, "name": "createSignedUploadUrl", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 329, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L329" } ], "signatures": [ { "id": 326, "name": "createSignedUploadUrl", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing signed upload URL, token, and path or error" } ] }, { "tag": "@example", "name": "Create Signed Upload URL", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUploadUrl('folder/cat.jpg')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/upload/sign/avatars/folder/cat.jpg?token=\",\n \"path\": \"folder/cat.jpg\",\n \"token\": \"\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`insert`" }, { "kind": "text", "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 329, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L329" } ], "parameters": [ { "id": 327, "name": "path", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The file path, including the current file name. For example " }, { "kind": "code", "text": "`folder/image.png`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 328, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 329, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 330, "name": "upsert", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "If set to true, allows the file to be overwritten if it already exists." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 331, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L331" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [330] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 331, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L331" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 331, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 332, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 334, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L334" } ], "type": { "type": "reflection", "declaration": { "id": 333, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 336, "name": "path", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 334, "character": 50, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L334" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 334, "name": "signedUrl", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 334, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L334" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 335, "name": "token", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 334, "character": 35, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L334" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [336, 334, 335] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 334, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L334" } ] } } }, { "id": 337, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 335, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L335" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [332, 337] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 333, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L333" } ] } }, { "type": "reflection", "declaration": { "id": 338, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 339, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 338, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L338" } ], "type": { "type": "literal", "value": null } }, { "id": 340, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 339, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L339" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [339, 340] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 337, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L337" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 382, "name": "createSignedUrl", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 630, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L630" } ], "signatures": [ { "id": 383, "name": "createSignedUrl", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing signed URL or error" } ] }, { "tag": "@example", "name": "Create Signed URL", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60)\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Create a signed URL for an asset with transformations", "content": [ { "kind": "code", "text": "```js\nconst { data } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60, {\n transform: {\n width: 100,\n height: 100,\n }\n })\n```" } ] }, { "tag": "@example", "name": "Create a signed URL which triggers the download of the asset", "content": [ { "kind": "code", "text": "```js\nconst { data } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60, {\n download: true,\n })\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 630, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L630" } ], "parameters": [ { "id": 384, "name": "path", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The file path, including the current file name. For example " }, { "kind": "code", "text": "`folder/image.png`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 385, "name": "expiresIn", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The number of seconds until the signed URL expires. For example, " }, { "kind": "code", "text": "`60`" }, { "kind": "text", "text": " for a URL which is valid for one minute." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 386, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 387, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 388, "name": "download", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "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." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 633, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L633" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "boolean" } ] } }, { "id": 389, "name": "transform", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Transform the asset before serving it to the client." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 633, "character": 45, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L633" } ], "type": { "type": "reference", "target": 1205, "name": "TransformOptions", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [388, 389] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 633, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L633" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 390, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 391, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 636, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L636" } ], "type": { "type": "reflection", "declaration": { "id": 392, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 393, "name": "signedUrl", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 636, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L636" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [393] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 636, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L636" } ] } } }, { "id": 394, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 637, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L637" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [391, 394] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 635, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L635" } ] } }, { "type": "reflection", "declaration": { "id": 395, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 396, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 640, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L640" } ], "type": { "type": "literal", "value": null } }, { "id": 397, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 641, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L641" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [396, 397] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 639, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L639" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 398, "name": "createSignedUrls", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 717, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L717" } ], "signatures": [ { "id": 399, "name": "createSignedUrls", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing array of objects with signedUrl, path, and error or error" } ] }, { "tag": "@example", "name": "Create Signed URLs", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUrls(['folder/avatar1.png', 'folder/avatar2.png'], 60)\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"error\": null,\n \"path\": \"folder/avatar1.png\",\n \"signedURL\": \"/object/sign/avatars/folder/avatar1.png?token=\",\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=\"\n },\n {\n \"error\": null,\n \"path\": \"folder/avatar2.png\",\n \"signedURL\": \"/object/sign/avatars/folder/avatar2.png?token=\",\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar2.png?token=\"\n }\n ],\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 717, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L717" } ], "parameters": [ { "id": 400, "name": "paths", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The file paths to be downloaded, including the current file names. For example " }, { "kind": "code", "text": "`['folder/image.png', 'folder2/image2.png']`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } }, { "id": 401, "name": "expiresIn", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The number of seconds until the signed URLs expire. For example, " }, { "kind": "code", "text": "`60`" }, { "kind": "text", "text": " for URLs which are valid for one minute." } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 402, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 403, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 404, "name": "download", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "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." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 720, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L720" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "boolean" } ] } } ], "groups": [ { "title": "Properties", "children": [404] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 720, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L720" } ] } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 405, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 406, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 723, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L723" } ], "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { "id": 407, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 408, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 723, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L723" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 409, "name": "path", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 723, "character": 38, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L723" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "string" } ] } }, { "id": 410, "name": "signedUrl", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 723, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L723" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [408, 409, 410] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 723, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L723" } ] } } } }, { "id": 411, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 724, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L724" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [406, 411] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 722, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L722" } ] } }, { "type": "reflection", "declaration": { "id": 412, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 413, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 727, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L727" } ], "type": { "type": "literal", "value": null } }, { "id": 414, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 728, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L728" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [413, 414] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 726, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L726" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 415, "name": "download", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 815, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L815" } ], "signatures": [ { "id": 416, "name": "download", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from " }, { "kind": "code", "text": "`getPublicUrl`" }, { "kind": "text", "text": " instead." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "BlobDownloadBuilder instance for downloading the file" } ] }, { "tag": "@example", "name": "Download file", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": ,\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Download file with transformations", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {\n transform: {\n width: 100,\n height: 100,\n quality: 80\n }\n })\n```" } ] }, { "tag": "@example", "name": "Download with cache control (useful in Edge Functions)", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {}, { cache: 'no-store' })\n```" } ] }, { "tag": "@example", "name": "Download with abort signal", "content": [ { "kind": "code", "text": "```js\nconst controller = new AbortController()\nsetTimeout(() => controller.abort(), 5000)\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png', {}, { signal: controller.signal })\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 815, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L815" } ], "typeParameters": [ { "id": 417, "name": "Options", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 418, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 419, "name": "transform", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 815, "character": 29, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L815" } ], "type": { "type": "reference", "target": 1205, "name": "TransformOptions", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [419] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 815, "character": 27, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L815" } ] } } } ], "parameters": [ { "id": 420, "name": "path", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The full path and file name of the file to be downloaded. For example " }, { "kind": "code", "text": "`folder/image.png`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 421, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": 417, "name": "Options", "package": "@supabase/storage-js", "refersToTypeParameter": true } }, { "id": 422, "name": "parameters", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Additional fetch parameters like signal for cancellation. Supports standard fetch options including cache control." } ] }, "type": { "type": "reference", "target": 1200, "name": "FetchParameters", "package": "@supabase/storage-js" } } ], "type": { "type": "reference", "target": 3, "name": "BlobDownloadBuilder", "package": "@supabase/storage-js", "qualifiedName": "default" } } ] }, { "id": 432, "name": "exists", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 897, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L897" } ], "signatures": [ { "id": 433, "name": "exists", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Checks the existence of a file." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing boolean indicating file existence or error" } ] }, { "tag": "@example", "name": "Check file existence", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .exists('folder/avatar1.png')\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 897, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L897" } ], "parameters": [ { "id": 434, "name": "path", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The file path, including the file name. For example " }, { "kind": "code", "text": "`folder/image.png`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 435, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 436, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 899, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L899" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 437, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 900, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L900" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [436, 437] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 898, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L898" } ] } }, { "type": "reflection", "declaration": { "id": 438, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 439, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 903, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L903" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 440, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 904, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L904" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [439, 440] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 902, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L902" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 441, "name": "getPublicUrl", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 994, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L994" } ], "signatures": [ { "id": 442, "name": "getPublicUrl", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Object with public URL" } ] }, { "tag": "@example", "name": "Returns the URL for an asset in a public bucket", "content": [ { "kind": "code", "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"publicUrl\": \"https://example.supabase.co/storage/v1/object/public/public-bucket/folder/avatar1.png\"\n }\n}\n```" } ] }, { "tag": "@example", "name": "Returns the URL for an asset in a public bucket with transformations", "content": [ { "kind": "code", "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png', {\n transform: {\n width: 100,\n height: 100,\n }\n })\n```" } ] }, { "tag": "@example", "name": "Returns the URL which triggers the download of an asset in a public bucket", "content": [ { "kind": "code", "text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png', {\n download: true,\n })\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- The bucket needs to be set to public, either via [updateBucket()](/docs/reference/javascript/storage-updatebucket) or by going to Storage on [supabase.com/dashboard](https://supabase.com/dashboard), clicking the overflow menu on a bucket and choosing \"Make public\"\n- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 994, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L994" } ], "parameters": [ { "id": 443, "name": "path", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The path and name of the file to generate the public URL for. For example " }, { "kind": "code", "text": "`folder/image.png`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 444, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 445, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 446, "name": "download", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "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." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 996, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L996" } ], "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "boolean" } ] } }, { "id": 447, "name": "transform", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Transform the asset before serving it to the client." } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 996, "character": 45, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L996" } ], "type": { "type": "reference", "target": 1205, "name": "TransformOptions", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [446, 447] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 996, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L996" } ] } } } ], "type": { "type": "reflection", "declaration": { "id": 448, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 449, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 997, "character": 7, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L997" } ], "type": { "type": "reflection", "declaration": { "id": 450, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 451, "name": "publicUrl", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 997, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L997" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [451] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 997, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L997" } ] } } } ], "groups": [ { "title": "Properties", "children": [449] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 997, "character": 5, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L997" } ] } } } ] }, { "id": 423, "name": "info", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 861, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L861" } ], "signatures": [ { "id": 424, "name": "info", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Retrieves the details of an existing file.\n\nReturns detailed file metadata including size, content type, and timestamps.\nNote: The API returns " }, { "kind": "code", "text": "`last_modified`" }, { "kind": "text", "text": " field, not " }, { "kind": "code", "text": "`updated_at`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing file metadata or error" } ] }, { "tag": "@example", "name": "Get file info", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .info('folder/avatar1.png')\n\nif (data) {\n console.log('Last modified:', data.lastModified)\n console.log('Size:', data.size)\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 861, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L861" } ], "parameters": [ { "id": 425, "name": "path", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The file path, including the file name. For example " }, { "kind": "code", "text": "`folder/image.png`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 426, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 427, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 863, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L863" } ], "type": { "type": "reference", "target": 1211, "typeArguments": [ { "type": "reference", "target": 1145, "name": "FileObjectV2", "package": "@supabase/storage-js" } ], "name": "Camelize", "package": "@supabase/storage-js" } }, { "id": 428, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 864, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L864" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [427, 428] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 862, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L862" } ] } }, { "type": "reflection", "declaration": { "id": 429, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 430, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 867, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L867" } ], "type": { "type": "literal", "value": null } }, { "id": 431, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 868, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L868" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [430, 431] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 866, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L866" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 461, "name": "list", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1223, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1223" } ], "signatures": [ { "id": 462, "name": "list", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Lists all the files and folders within a path of the bucket.\n\n**Important:** For folder entries, fields like " }, { "kind": "code", "text": "`id`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`updated_at`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`created_at`" }, { "kind": "text", "text": ",\n" }, { "kind": "code", "text": "`last_accessed_at`" }, { "kind": "text", "text": ", and " }, { "kind": "code", "text": "`metadata`" }, { "kind": "text", "text": " will be " }, { "kind": "code", "text": "`null`" }, { "kind": "text", "text": ". Only files have these fields populated.\nAdditionally, deprecated fields like " }, { "kind": "code", "text": "`bucket_id`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`owner`" }, { "kind": "text", "text": ", and " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " are NOT returned\nby this method." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing array of files/folders or error" } ] }, { "tag": "@example", "name": "List files in a bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .list('folder', {\n limit: 100,\n offset: 0,\n sortBy: { column: 'name', order: 'asc' },\n })\n\n// Handle files vs folders\ndata?.forEach(item => {\n if (item.id !== null) {\n // It's a file\n console.log('File:', item.name, 'Size:', item.metadata?.size)\n } else {\n // It's a folder\n console.log('Folder:', item.name)\n }\n})\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"avatar1.png\",\n \"id\": \"e668cf7f-821b-4a2f-9dce-7dfa5dd1cfd2\",\n \"updated_at\": \"2024-05-22T23:06:05.580Z\",\n \"created_at\": \"2024-05-22T23:04:34.443Z\",\n \"last_accessed_at\": \"2024-05-22T23:04:34.443Z\",\n \"metadata\": {\n \"eTag\": \"\\\"c5e8c553235d9af30ef4f6e280790b92\\\"\",\n \"size\": 32175,\n \"mimetype\": \"image/png\",\n \"cacheControl\": \"max-age=3600\",\n \"lastModified\": \"2024-05-22T23:06:05.574Z\",\n \"contentLength\": 32175,\n \"httpStatusCode\": 200\n }\n }\n ],\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Search files in a bucket", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .list('folder', {\n limit: 100,\n offset: 0,\n sortBy: { column: 'name', order: 'asc' },\n search: 'jon'\n })\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1223, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1223" } ], "parameters": [ { "id": 463, "name": "path", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The folder path." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 464, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Search options including limit (defaults to 100), offset, sortBy, and search" } ] }, "type": { "type": "reference", "target": 1170, "name": "SearchOptions", "package": "@supabase/storage-js" } }, { "id": 465, "name": "parameters", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional fetch parameters including signal for cancellation" } ] }, "type": { "type": "reference", "target": 1200, "name": "FetchParameters", "package": "@supabase/storage-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 466, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 467, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1229, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1229" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1135, "name": "FileObject", "package": "@supabase/storage-js" } } }, { "id": 468, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1230, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1230" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [467, 468] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1228, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1228" } ] } }, { "type": "reflection", "declaration": { "id": 469, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 470, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1233, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1233" } ], "type": { "type": "literal", "value": null } }, { "id": 471, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1234, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1234" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [470, 471] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1232, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1232" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 472, "name": "listV2", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1295, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1295" } ], "signatures": [ { "id": 473, "name": "listV2", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Lists all the files and folders within a bucket using the V2 API with pagination support.\n\n**Important:** Folder entries in the " }, { "kind": "code", "text": "`folders`" }, { "kind": "text", "text": " array only contain " }, { "kind": "code", "text": "`name`" }, { "kind": "text", "text": " and optionally " }, { "kind": "code", "text": "`key`" }, { "kind": "text", "text": " —\nthey have no " }, { "kind": "code", "text": "`id`" }, { "kind": "text", "text": ", timestamps, or " }, { "kind": "code", "text": "`metadata`" }, { "kind": "text", "text": " fields. Full file metadata is only available\non entries in the " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " array.\n\n this method signature might change in the future" } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing folders/objects arrays with pagination info or error" } ] }, { "tag": "@example", "name": "List files with pagination", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .listV2({\n prefix: 'folder/',\n limit: 100,\n })\n\n// Handle pagination\nif (data?.hasNext) {\n const nextPage = await supabase\n .storage\n .from('avatars')\n .listV2({\n prefix: 'folder/',\n cursor: data.nextCursor,\n })\n}\n\n// Handle files vs folders\ndata?.objects.forEach(file => {\n if (file.id !== null) {\n console.log('File:', file.name, 'Size:', file.metadata?.size)\n }\n})\ndata?.folders.forEach(folder => {\n console.log('Folder:', folder.name)\n})\n```" } ] } ], "modifierTags": ["@experimental"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1295, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1295" } ], "parameters": [ { "id": 474, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Search options including prefix, cursor for pagination, limit, with_delimiter" } ] }, "type": { "type": "reference", "target": 1178, "name": "SearchV2Options", "package": "@supabase/storage-js" } }, { "id": 475, "name": "parameters", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional fetch parameters including signal for cancellation" } ] }, "type": { "type": "reference", "target": 1200, "name": "FetchParameters", "package": "@supabase/storage-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 476, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 477, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1300, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1300" } ], "type": { "type": "reference", "target": 1195, "name": "SearchV2Result", "package": "@supabase/storage-js" } }, { "id": 478, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1301, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1301" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [477, 478] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1299, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1299" } ] } }, { "type": "reflection", "declaration": { "id": 479, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 480, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1304, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1304" } ], "type": { "type": "literal", "value": null } }, { "id": 481, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1305, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1305" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [480, 481] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1303, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1303" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 356, "name": "move", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 481, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L481" } ], "signatures": [ { "id": 357, "name": "move", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Moves an existing file to a new path in the same bucket." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing success message or error" } ] }, { "tag": "@example", "name": "Move file", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .move('public/avatar1.png', 'private/avatar2.png')\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"message\": \"Successfully moved\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`update`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 481, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L481" } ], "parameters": [ { "id": 358, "name": "fromPath", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The original file path, including the current file name. For example " }, { "kind": "code", "text": "`folder/image.png`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 359, "name": "toPath", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The new file path, including the new file name. For example " }, { "kind": "code", "text": "`folder/image-new.png`" }, { "kind": "text", "text": "." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 360, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The destination options." } ] }, "type": { "type": "reference", "target": 1168, "name": "DestinationOptions", "package": "@supabase/storage-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 361, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 362, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 487, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L487" } ], "type": { "type": "reflection", "declaration": { "id": 363, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 364, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 487, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L487" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [364] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 487, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L487" } ] } } }, { "id": 365, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 488, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L488" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [362, 365] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 486, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L486" } ] } }, { "type": "reflection", "declaration": { "id": 366, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 367, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 491, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L491" } ], "type": { "type": "literal", "value": null } }, { "id": 368, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 492, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L492" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [367, 368] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 490, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L490" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 452, "name": "remove", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1059, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1059" } ], "signatures": [ { "id": 453, "name": "remove", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Deletes files within the same bucket\n\nReturns an array of FileObject entries for the deleted files. Note that deprecated\nfields like " }, { "kind": "code", "text": "`bucket_id`" }, { "kind": "text", "text": " may or may not be present in the response - do not rely on them." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing array of deleted file objects or error" } ] }, { "tag": "@example", "name": "Delete file", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .remove(['folder/avatar1.png'])\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [],\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`delete`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1059, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1059" } ], "parameters": [ { "id": 454, "name": "paths", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "An array of files to delete, including the path and file name. For example [" }, { "kind": "code", "text": "`'folder/image.png'`" }, { "kind": "text", "text": "]." } ] }, "type": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 455, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 456, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1061, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1061" } ], "type": { "type": "array", "elementType": { "type": "reference", "target": 1135, "name": "FileObject", "package": "@supabase/storage-js" } } }, { "id": 457, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1062, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1062" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [456, 457] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1060, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1060" } ] } }, { "type": "reflection", "declaration": { "id": 458, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 459, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1065, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1065" } ], "type": { "type": "literal", "value": null } }, { "id": 460, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1066, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1066" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [459, 460] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1064, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1064" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 514, "name": "setHeader", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "signatures": [ { "id": 515, "name": "setHeader", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "parameters": [ { "id": 516, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 517, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header value" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.setHeader" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.setHeader" } }, { "id": 512, "name": "throwOnError", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "signatures": [ { "id": 513, "name": "throwOnError", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.throwOnError" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "BaseApiClient.throwOnError" } }, { "id": 485, "name": "toBase64", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1324, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1324" } ], "signatures": [ { "id": 486, "name": "toBase64", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1324, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1324" } ], "parameters": [ { "id": 487, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] }, { "id": 341, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 421, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L421" } ], "signatures": [ { "id": 342, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Replaces an existing file at the specified path with a new one." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing file path, id, and fullPath or error" } ] }, { "tag": "@example", "name": "Update file", "content": [ { "kind": "code", "text": "```js\nconst avatarFile = event.target.files[0]\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .update('public/avatar1.png', avatarFile, {\n cacheControl: '3600',\n upsert: true\n })\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"path\": \"public/avatar1.png\",\n \"fullPath\": \"avatars/public/avatar1.png\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Update file using `ArrayBuffer` from base64 file data", "content": [ { "kind": "code", "text": "```js\nimport {decode} from 'base64-arraybuffer'\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .update('public/avatar1.png', decode('base64FileData'), {\n contentType: 'image/png'\n })\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: " }, { "kind": "code", "text": "`update`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": "\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works\n- For React Native, using either " }, { "kind": "code", "text": "`Blob`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`File`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`FormData`" }, { "kind": "text", "text": " does not work as intended. Update file using " }, { "kind": "code", "text": "`ArrayBuffer`" }, { "kind": "text", "text": " from base64 file data instead, see example below." } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 421, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L421" } ], "parameters": [ { "id": 343, "name": "path", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The relative file path. Should be of the format " }, { "kind": "code", "text": "`folder/subfolder/filename.png`" }, { "kind": "text", "text": ". The bucket must already exist before attempting to update." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 344, "name": "fileBody", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The body of the file to be stored in the bucket." } ] }, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "ArrayBuffer" }, "name": "ArrayBuffer", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "ReadableStream" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Uint8Array" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "ArrayBufferLike" }, "name": "ArrayBufferLike", "package": "typescript" } ], "name": "Uint8Array", "package": "typescript" } ], "name": "ReadableStream", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Blob" }, "name": "Blob", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "File" }, "name": "File", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "FormData" }, "name": "FormData", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "__global.NodeJS.ReadableStream" }, "name": "ReadableStream", "package": "@types/node", "qualifiedName": "__global.NodeJS.ReadableStream" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URLSearchParams" }, "name": "URLSearchParams", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "ArrayBufferView" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "ArrayBufferLike" }, "name": "ArrayBufferLike", "package": "typescript" } ], "name": "ArrayBufferView", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/@types/node/buffer.buffer.d.ts", "qualifiedName": "__global.Buffer" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "ArrayBufferLike" }, "name": "ArrayBufferLike", "package": "typescript" } ], "name": "Buffer", "package": "@types/node", "qualifiedName": "__global.Buffer" } ] } }, { "id": 345, "name": "fileOptions", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional file upload options including cacheControl, contentType, upsert, and metadata." } ] }, "type": { "type": "reference", "target": 1161, "name": "FileOptions", "package": "@supabase/storage-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 346, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 347, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 437, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L437" } ], "type": { "type": "reflection", "declaration": { "id": 348, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 351, "name": "fullPath", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 437, "character": 42, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L437" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 349, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 437, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L437" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 350, "name": "path", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 437, "character": 28, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L437" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [351, 349, 350] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 437, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L437" } ] } } }, { "id": 352, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 438, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L438" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [347, 352] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 436, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L436" } ] } }, { "type": "reflection", "declaration": { "id": 353, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 354, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 441, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L441" } ], "type": { "type": "literal", "value": null } }, { "id": 355, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 442, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L442" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [354, 355] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 440, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L440" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 295, "name": "upload", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 200, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L200" } ], "signatures": [ { "id": 296, "name": "upload", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Uploads a file to an existing bucket." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing file path, id, and fullPath or error" } ] }, { "tag": "@example", "name": "Upload file", "content": [ { "kind": "code", "text": "```js\nconst avatarFile = event.target.files[0]\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', avatarFile, {\n cacheControl: '3600',\n upsert: false\n })\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"path\": \"public/avatar1.png\",\n \"fullPath\": \"avatars/public/avatar1.png\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@example", "name": "Upload file using `ArrayBuffer` from base64 file data", "content": [ { "kind": "code", "text": "```js\nimport { decode } from 'base64-arraybuffer'\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', decode('base64FileData'), {\n contentType: 'image/png'\n })\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: only " }, { "kind": "code", "text": "`insert`" }, { "kind": "text", "text": " when you are uploading new files and " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`insert`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`update`" }, { "kind": "text", "text": " when you are upserting files\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works\n- For React Native, using either " }, { "kind": "code", "text": "`Blob`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`File`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`FormData`" }, { "kind": "text", "text": " does not work as intended. Upload file using " }, { "kind": "code", "text": "`ArrayBuffer`" }, { "kind": "text", "text": " from base64 file data instead, see example below." } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 200, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L200" } ], "parameters": [ { "id": 297, "name": "path", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The file path, including the file name. Should be of the format " }, { "kind": "code", "text": "`folder/subfolder/filename.png`" }, { "kind": "text", "text": ". The bucket must already exist before attempting to upload." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 298, "name": "fileBody", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The body of the file to be stored in the bucket." } ] }, "type": { "type": "reference", "target": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "FileBody" }, "name": "FileBody", "package": "@supabase/storage-js" } }, { "id": 299, "name": "fileOptions", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional file upload options including cacheControl, contentType, upsert, and metadata." } ] }, "type": { "type": "reference", "target": 1161, "name": "FileOptions", "package": "@supabase/storage-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 300, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 301, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 206, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L206" } ], "type": { "type": "reflection", "declaration": { "id": 302, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 305, "name": "fullPath", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 206, "character": 42, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L206" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 303, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 206, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L206" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 304, "name": "path", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 206, "character": 28, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L206" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [305, 303, 304] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 206, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L206" } ] } } }, { "id": 306, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 207, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L207" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [301, 306] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 205, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L205" } ] } }, { "type": "reflection", "declaration": { "id": 307, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 308, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 210, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L210" } ], "type": { "type": "literal", "value": null } }, { "id": 309, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 211, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L211" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [308, 309] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 209, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L209" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] }, { "id": 310, "name": "uploadToSignedUrl", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 254, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L254" } ], "signatures": [ { "id": 311, "name": "uploadToSignedUrl", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Upload a file with a token generated from " }, { "kind": "code", "text": "`createSignedUploadUrl`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "File Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing file path and fullPath or error" } ] }, { "tag": "@example", "name": "Upload to a signed URL", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .uploadToSignedUrl('folder/cat.jpg', 'token-from-createSignedUploadUrl', file)\n```" }, { "kind": "text", "text": "\n\nResponse:\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"path\": \"folder/cat.jpg\",\n \"fullPath\": \"avatars/folder/cat.jpg\"\n },\n \"error\": null\n}\n```" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- RLS policy permissions required:\n - " }, { "kind": "code", "text": "`buckets`" }, { "kind": "text", "text": " table permissions: none\n - " }, { "kind": "code", "text": "`objects`" }, { "kind": "text", "text": " table permissions: none\n- Refer to the [Storage guide](/docs/guides/storage/security/access-control) on how access control works" } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 254, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L254" } ], "parameters": [ { "id": 312, "name": "path", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The file path, including the file name. Should be of the format " }, { "kind": "code", "text": "`folder/subfolder/filename.png`" }, { "kind": "text", "text": ". The bucket must already exist before attempting to upload." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 313, "name": "token", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The token generated from " }, { "kind": "code", "text": "`createSignedUploadUrl`" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 314, "name": "fileBody", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The body of the file to be stored in the bucket." } ] }, "type": { "type": "reference", "target": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "FileBody" }, "name": "FileBody", "package": "@supabase/storage-js" } }, { "id": 315, "name": "fileOptions", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "HTTP headers (cacheControl, contentType, etc.).\n**Note:** The " }, { "kind": "code", "text": "`upsert`" }, { "kind": "text", "text": " option has no effect here. To enable upsert behavior,\npass " }, { "kind": "code", "text": "`{ upsert: true }`" }, { "kind": "text", "text": " when calling " }, { "kind": "code", "text": "`createSignedUploadUrl()`" }, { "kind": "text", "text": " instead." } ] }, "type": { "type": "reference", "target": 1161, "name": "FileOptions", "package": "@supabase/storage-js" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reflection", "declaration": { "id": 316, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 317, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 89, "character": 42, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L89" } ], "type": { "type": "literal", "value": null } }, { "id": 318, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 89, "character": 54, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L89" } ], "type": { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [317, 318] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 89, "character": 40, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L89" } ] } }, { "type": "reflection", "declaration": { "id": 319, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 320, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 89, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L89" } ], "type": { "type": "reflection", "declaration": { "id": 321, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 323, "name": "fullPath", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 289, "character": 32, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L289" } ], "type": { "type": "intrinsic", "name": "any" }, "defaultValue": "data.Key" }, { "id": 322, "name": "path", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 289, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L289" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "cleanPath" } ], "groups": [ { "title": "Properties", "children": [323, 322] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 289, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L289" } ] } } }, { "id": 324, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 89, "character": 24, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L89" } ], "type": { "type": "literal", "value": null } } ], "groups": [ { "title": "Properties", "children": [320, 324] } ], "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 89, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L89" } ] } } ] } ], "name": "Promise", "package": "typescript" } } ] } ], "groups": [ { "title": "Constructors", "children": [262] }, { "title": "Methods", "children": [ 369, 325, 382, 398, 415, 432, 441, 423, 461, 472, 356, 452, 514, 512, 485, 341, 295, 310 ] } ], "categories": [ { "title": "File Buckets", "children": [ 369, 325, 382, 398, 415, 432, 441, 423, 461, 472, 356, 452, 341, 295, 310 ] }, { "title": "Other", "children": [262, 514, 512, 485] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 51, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L51" } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default" }, "typeArguments": [ { "type": "reference", "target": 1329, "name": "StorageError", "package": "@supabase/storage-js" } ], "name": "default", "package": "@supabase/storage-js" } ] } ], "groups": [ { "title": "Classes", "children": [261] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts", "line": 1, "character": 0, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageFileApi.ts#L1" } ] }, { "id": 530, "name": "packages/StorageVectorsClient", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { "id": 544, "name": "StorageVectorsClient", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Main client for interacting with S3 Vectors API\nProvides access to bucket, index, and vector data operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type.\n\n**Usage Patterns:**\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .createBucket('embeddings-prod')\n\n// Access index operations via buckets\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine'\n})\n\n// Access vector operations via index\nconst index = bucket.index('documents')\nawait index.putVectors({\n vectors: [\n { key: 'doc-1', data: { float32: [...] }, metadata: { title: 'Intro' } }\n ]\n})\n\n// Query similar vectors\nconst { data } = await index.queryVectors({\n queryVector: { float32: [...] },\n topK: 5,\n returnDistance: true\n})\n```" } ], "modifierTags": ["@alpha"] }, "children": [ { "id": 545, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 98, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L98" } ], "signatures": [ { "id": 546, "name": "StorageVectorsClient", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@example", "name": "Creating a StorageVectorsClient instance", "content": [ { "kind": "code", "text": "```typescript\nconst client = new StorageVectorsClient(url, options)\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 98, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L98" } ], "parameters": [ { "id": 547, "name": "url", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Base URL of the Storage Vectors REST API." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 548, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 531, "name": "StorageVectorsClientOptions", "package": "@supabase/storage-js", "highlightedProperties": { "headers": [ { "kind": "text", "text": "Optional headers (for example " }, { "kind": "code", "text": "`Authorization`" }, { "kind": "text", "text": ") applied to every request." } ], "fetch": [ { "kind": "text", "text": "Optional custom " }, { "kind": "code", "text": "`fetch`" }, { "kind": "text", "text": " implementation for non-browser runtimes." } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": 544, "name": "StorageVectorsClient", "package": "@supabase/storage-js" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorBucketApi.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorBucketApi.constructor" } }, { "id": 552, "name": "createBucket", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 145, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L145" } ], "signatures": [ { "id": 553, "name": "createBucket", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a new vector bucket\nVector buckets are containers for vector indexes and their data\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with empty response on success or error" } ] }, { "tag": "@example", "name": "Creating a vector bucket", "content": [ { "kind": "code", "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .createBucket('embeddings-prod')\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 145, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L145" } ], "parameters": [ { "id": 554, "name": "vectorBucketName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique name for the vector bucket" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "intrinsic", "name": "undefined" } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorBucketApi.createBucket" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorBucketApi.createBucket" } }, { "id": 563, "name": "deleteBucket", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 226, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L226" } ], "signatures": [ { "id": 564, "name": "deleteBucket", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Deletes a vector bucket (bucket must be empty)\nAll indexes must be deleted before deleting the bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with empty response on success or error" } ] }, { "tag": "@example", "name": "Delete a vector bucket", "content": [ { "kind": "code", "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .deleteBucket('embeddings-old')\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 226, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L226" } ], "parameters": [ { "id": 565, "name": "vectorBucketName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the vector bucket to delete" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "intrinsic", "name": "undefined" } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorBucketApi.deleteBucket" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorBucketApi.deleteBucket" } }, { "id": 549, "name": "from", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 120, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L120" } ], "signatures": [ { "id": 550, "name": "from", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Access operations for a specific vector bucket\nReturns a scoped client for index and vector operations within the bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Bucket-scoped client with index and vector operations" } ] }, { "tag": "@example", "name": "Accessing a vector bucket", "content": [ { "kind": "code", "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 120, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L120" } ], "parameters": [ { "id": 551, "name": "vectorBucketName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the vector bucket" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 599, "name": "VectorBucketScope", "package": "@supabase/storage-js" } } ] }, { "id": 555, "name": "getBucket", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 171, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L171" } ], "signatures": [ { "id": 556, "name": "getBucket", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Retrieves metadata for a specific vector bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with bucket metadata or error" } ] }, { "tag": "@example", "name": "Get bucket metadata", "content": [ { "kind": "code", "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .getBucket('embeddings-prod')\n\nconsole.log('Bucket created:', data?.vectorBucket.creationTime)\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 171, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L171" } ], "parameters": [ { "id": 557, "name": "vectorBucketName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the vector bucket" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "reflection", "declaration": { "id": 558, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 559, "name": "vectorBucket", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 171, "character": 67, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L171" } ], "type": { "type": "reference", "target": 1224, "name": "VectorBucket", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [559] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 171, "character": 65, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L171" } ] } } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorBucketApi.getBucket" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorBucketApi.getBucket" } }, { "id": 560, "name": "listBuckets", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 199, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L199" } ], "signatures": [ { "id": 561, "name": "listBuckets", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Lists all vector buckets with optional filtering and pagination\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with list of buckets or error" } ] }, { "tag": "@example", "name": "List vector buckets", "content": [ { "kind": "code", "text": "```typescript\nconst { data, error } = await supabase\n .storage\n .vectors\n .listBuckets({ prefix: 'embeddings-' })\n\ndata?.vectorBuckets.forEach(bucket => {\n console.log(bucket.vectorBucketName)\n})\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 199, "character": 8, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L199" } ], "parameters": [ { "id": 562, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Optional filters (prefix, maxResults, nextToken)" } ] }, "type": { "type": "reference", "target": 1252, "name": "ListVectorBucketsOptions", "package": "@supabase/storage-js" }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "reference", "target": 1256, "name": "ListVectorBucketsResponse", "package": "@supabase/storage-js" } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorBucketApi.listBuckets" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorBucketApi.listBuckets" } }, { "id": 583, "name": "setHeader", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "signatures": [ { "id": 584, "name": "setHeader", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "parameters": [ { "id": 585, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 586, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header value" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorBucketApi.setHeader" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorBucketApi.setHeader" } }, { "id": 581, "name": "throwOnError", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "signatures": [ { "id": 582, "name": "throwOnError", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorBucketApi.throwOnError" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorBucketApi.throwOnError" } } ], "groups": [ { "title": "Constructors", "children": [545] }, { "title": "Methods", "children": [552, 563, 549, 555, 560, 583, 581] } ], "categories": [ { "title": "Other", "children": [583, 581] }, { "title": "Vector Buckets", "children": [545, 552, 563, 549, 555, 560] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 80, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L80" } ], "extendedTypes": [ { "type": "reference", "target": -1, "name": "default", "package": "@supabase/storage-js" } ] }, { "id": 599, "name": "VectorBucketScope", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Scoped client for operations within a specific vector bucket\nProvides index management and access to vector operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "modifierTags": ["@alpha"] }, "children": [ { "id": 600, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 256, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L256" } ], "signatures": [ { "id": 601, "name": "VectorBucketScope", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a helper that automatically scopes all index operations to the provided bucket.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@example", "name": "Creating a vector bucket scope", "content": [ { "kind": "code", "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 256, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L256" } ], "parameters": [ { "id": 602, "name": "url", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 603, "name": "headers", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 604, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 258, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L258" } ], "indexSignatures": [ { "id": 605, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 258, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L258" } ], "parameters": [ { "id": 606, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 607, "name": "vectorBucketName", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 608, "name": "fetch", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 609, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 610, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 611, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 612, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 613, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 614, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 615, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } } ], "type": { "type": "reference", "target": 599, "name": "VectorBucketScope", "package": "@supabase/storage-js" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorIndexApi.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorIndexApi.constructor" } }, { "id": 617, "name": "createIndex", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 293, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L293" } ], "signatures": [ { "id": 618, "name": "createIndex", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a new vector index in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with empty response on success or error" } ] }, { "tag": "@example", "name": "Creating a vector index", "content": [ { "kind": "code", "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents-openai',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine',\n metadataConfiguration: {\n nonFilterableMetadataKeys: ['raw_text']\n }\n})\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 293, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L293" } ], "parameters": [ { "id": 619, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Index configuration (vectorBucketName is automatically set)" } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 891, "name": "CreateIndexOptions", "package": "@supabase/storage-js" }, { "type": "literal", "value": "vectorBucketName" } ], "name": "Omit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "intrinsic", "name": "undefined" } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorIndexApi.createIndex" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorIndexApi.createIndex" } }, { "id": 628, "name": "deleteIndex", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 369, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L369" } ], "signatures": [ { "id": 629, "name": "deleteIndex", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Deletes an index from this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with empty response on success or error" } ] }, { "tag": "@example", "name": "Delete an index", "content": [ { "kind": "code", "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nawait bucket.deleteIndex('old-index')\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 369, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L369" } ], "parameters": [ { "id": 630, "name": "indexName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the index to delete" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "intrinsic", "name": "undefined" } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorIndexApi.deleteIndex" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorIndexApi.deleteIndex" } }, { "id": 623, "name": "getIndex", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 346, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L346" } ], "signatures": [ { "id": 624, "name": "getIndex", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Retrieves metadata for a specific index in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with index metadata or error" } ] }, { "tag": "@example", "name": "Get index metadata", "content": [ { "kind": "code", "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nconst { data } = await bucket.getIndex('documents-openai')\nconsole.log('Dimension:', data?.index.dimension)\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 346, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L346" } ], "parameters": [ { "id": 625, "name": "indexName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the index to retrieve" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "reflection", "declaration": { "id": 626, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 627, "name": "index", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", "line": 58, "character": 27, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorIndexApi.ts#L58" } ], "type": { "type": "reference", "target": 1232, "name": "VectorIndex", "package": "@supabase/storage-js" } } ], "groups": [ { "title": "Properties", "children": [627] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", "line": 58, "character": 25, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorIndexApi.ts#L58" } ] } } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorIndexApi.getIndex" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorIndexApi.getIndex" } }, { "id": 631, "name": "index", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 404, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L404" } ], "signatures": [ { "id": 632, "name": "index", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Access operations for a specific index within this bucket\nReturns a scoped client for vector data operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Index-scoped client with vector data operations" } ] }, { "tag": "@example", "name": "Accessing an index", "content": [ { "kind": "code", "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\n\n// Insert vectors\nawait index.putVectors({\n vectors: [\n { key: 'doc-1', data: { float32: [...] }, metadata: { title: 'Intro' } }\n ]\n})\n\n// Query similar vectors\nconst { data } = await index.queryVectors({\n queryVector: { float32: [...] },\n topK: 5\n})\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 404, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L404" } ], "parameters": [ { "id": 633, "name": "indexName", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Name of the index" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "reference", "target": 667, "name": "VectorIndexScope", "package": "@supabase/storage-js" } } ] }, { "id": 620, "name": "listIndexes", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 319, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L319" } ], "signatures": [ { "id": 621, "name": "listIndexes", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Lists indexes in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing indexes array and pagination token or error" } ] }, { "tag": "@example", "name": "List indexes", "content": [ { "kind": "code", "text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\nconst { data } = await bucket.listIndexes({ prefix: 'documents-' })\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 319, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L319" } ], "parameters": [ { "id": 622, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Listing options (vectorBucketName is automatically set)" } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 1261, "name": "ListIndexesOptions", "package": "@supabase/storage-js" }, { "type": "literal", "value": "vectorBucketName" } ], "name": "Omit", "package": "typescript" }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "reference", "target": 1266, "name": "ListIndexesResponse", "package": "@supabase/storage-js" } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorIndexApi.listIndexes" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorIndexApi.listIndexes" } }, { "id": 651, "name": "setHeader", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "signatures": [ { "id": 652, "name": "setHeader", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "parameters": [ { "id": 653, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 654, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header value" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorIndexApi.setHeader" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorIndexApi.setHeader" } }, { "id": 649, "name": "throwOnError", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "signatures": [ { "id": 650, "name": "throwOnError", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorIndexApi.throwOnError" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorIndexApi.throwOnError" } } ], "groups": [ { "title": "Constructors", "children": [600] }, { "title": "Methods", "children": [617, 628, 623, 631, 620, 651, 649] } ], "categories": [ { "title": "Other", "children": [651, 649] }, { "title": "Vector Buckets", "children": [600, 617, 628, 623, 631, 620] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 240, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L240" } ], "extendedTypes": [ { "type": "reference", "target": -1, "name": "default", "package": "@supabase/storage-js" } ] }, { "id": 667, "name": "VectorIndexScope", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Scoped client for operations within a specific vector index\nProvides vector data operations (put, get, list, query, delete)\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "modifierTags": ["@alpha"] }, "children": [ { "id": 668, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 442, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L442" } ], "signatures": [ { "id": 669, "name": "VectorIndexScope", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a helper that automatically scopes all vector operations to the provided bucket/index names.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@example", "name": "Creating a vector index scope", "content": [ { "kind": "code", "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 442, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L442" } ], "parameters": [ { "id": 670, "name": "url", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 671, "name": "headers", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 672, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 444, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L444" } ], "indexSignatures": [ { "id": 673, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 444, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L444" } ], "parameters": [ { "id": 674, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } }, { "id": 675, "name": "vectorBucketName", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 676, "name": "indexName", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 677, "name": "fetch", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 678, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 679, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 680, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 681, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 682, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 683, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 684, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } } ], "type": { "type": "reference", "target": 667, "name": "VectorIndexScope", "package": "@supabase/storage-js" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.constructor" } }, { "id": 699, "name": "deleteVectors", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 607, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L607" } ], "signatures": [ { "id": 700, "name": "deleteVectors", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Deletes vectors by keys from this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with empty response on success or error" } ] }, { "tag": "@example", "name": "Delete vectors by keys", "content": [ { "kind": "code", "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nawait index.deleteVectors({\n keys: ['doc-1', 'doc-2', 'doc-3']\n})\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 607, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L607" } ], "parameters": [ { "id": 701, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Deletion options (bucket and index names automatically set)" } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 1283, "name": "DeleteVectorsOptions", "package": "@supabase/storage-js" }, { "type": "union", "types": [ { "type": "literal", "value": "vectorBucketName" }, { "type": "literal", "value": "indexName" } ] } ], "name": "Omit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "intrinsic", "name": "undefined" } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.deleteVectors" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.deleteVectors" } }, { "id": 690, "name": "getVectors", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 511, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L511" } ], "signatures": [ { "id": 691, "name": "getVectors", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Retrieves vectors by keys from this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing vectors array or error" } ] }, { "tag": "@example", "name": "Get vectors by keys", "content": [ { "kind": "code", "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.getVectors({\n keys: ['doc-1', 'doc-2'],\n returnMetadata: true\n})\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 511, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L511" } ], "parameters": [ { "id": 692, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Vector retrieval options (bucket and index names automatically set)" } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 1271, "name": "GetVectorsOptions", "package": "@supabase/storage-js" }, { "type": "union", "types": [ { "type": "literal", "value": "vectorBucketName" }, { "type": "literal", "value": "indexName" } ] } ], "name": "Omit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "reference", "target": 1277, "name": "GetVectorsResponse", "package": "@supabase/storage-js" } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.getVectors" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.getVectors" } }, { "id": 693, "name": "listVectors", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 541, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L541" } ], "signatures": [ { "id": 694, "name": "listVectors", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Lists vectors in this index with pagination\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing vectors array and pagination token or error" } ] }, { "tag": "@example", "name": "List vectors with pagination", "content": [ { "kind": "code", "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.listVectors({\n maxResults: 500,\n returnMetadata: true\n})\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 541, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L541" } ], "parameters": [ { "id": 695, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Listing options (bucket and index names automatically set)" } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 1287, "name": "ListVectorsOptions", "package": "@supabase/storage-js" }, { "type": "union", "types": [ { "type": "literal", "value": "vectorBucketName" }, { "type": "literal", "value": "indexName" } ] } ], "name": "Omit", "package": "typescript" }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "reference", "target": 1296, "name": "ListVectorsResponse", "package": "@supabase/storage-js" } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.listVectors" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.listVectors" } }, { "id": 687, "name": "putVectors", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 481, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L481" } ], "signatures": [ { "id": 688, "name": "putVectors", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Inserts or updates vectors in this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with empty response on success or error" } ] }, { "tag": "@example", "name": "Insert vectors into an index", "content": [ { "kind": "code", "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nawait index.putVectors({\n vectors: [\n {\n key: 'doc-1',\n data: { float32: [0.1, 0.2, ...] },\n metadata: { title: 'Introduction', page: 1 }\n }\n ]\n})\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 481, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L481" } ], "parameters": [ { "id": 689, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Vector insertion options (bucket and index names automatically set)" } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 1279, "name": "PutVectorsOptions", "package": "@supabase/storage-js" }, { "type": "union", "types": [ { "type": "literal", "value": "vectorBucketName" }, { "type": "literal", "value": "indexName" } ] } ], "name": "Omit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "intrinsic", "name": "undefined" } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.putVectors" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.putVectors" } }, { "id": 696, "name": "queryVectors", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 576, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L576" } ], "signatures": [ { "id": 697, "name": "queryVectors", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Queries for similar vectors in this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Vector Buckets" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "Promise with response containing matches array of similar vectors ordered by distance or error" } ] }, { "tag": "@example", "name": "Query similar vectors", "content": [ { "kind": "code", "text": "```typescript\nconst index = supabase.storage.vectors.from('embeddings-prod').index('documents-openai')\nconst { data } = await index.queryVectors({\n queryVector: { float32: [0.1, 0.2, ...] },\n topK: 5,\n filter: { category: 'technical' },\n returnDistance: true,\n returnMetadata: true\n})\n```" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 576, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L576" } ], "parameters": [ { "id": 698, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Query options (bucket and index names automatically set)" } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 1300, "name": "QueryVectorsOptions", "package": "@supabase/storage-js" }, { "type": "union", "types": [ { "type": "literal", "value": "vectorBucketName" }, { "type": "literal", "value": "indexName" } ] } ], "name": "Omit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": 1320, "typeArguments": [ { "type": "reference", "target": 1308, "name": "QueryVectorsResponse", "package": "@supabase/storage-js" } ], "name": "ApiResponse", "package": "@supabase/storage-js" } ], "name": "Promise", "package": "typescript" }, "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.queryVectors" } } ], "overwrites": { "type": "reference", "target": -1, "name": "VectorDataApi.queryVectors" } }, { "id": 719, "name": "setHeader", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "signatures": [ { "id": 720, "name": "setHeader", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Set an HTTP header for the request.\nCreates a shallow copy of headers to avoid mutating shared state." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 57, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L57" } ], "parameters": [ { "id": 721, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header name" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 722, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Header value" } ] }, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorDataApi.setHeader" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorDataApi.setHeader" } }, { "id": 717, "name": "throwOnError", "variant": "declaration", "kind": 2048, "flags": { "isPublic": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "signatures": [ { "id": 718, "name": "throwOnError", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Enable throwing errors instead of returning them.\nWhen enabled, errors are thrown instead of returned in { data, error } format." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "this - For method chaining" } ] } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts", "line": 44, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L44" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorDataApi.throwOnError" } } ], "inheritedFrom": { "type": "reference", "target": -1, "name": "VectorDataApi.throwOnError" } } ], "groups": [ { "title": "Constructors", "children": [668] }, { "title": "Methods", "children": [699, 690, 693, 687, 696, 719, 717] } ], "categories": [ { "title": "Other", "children": [719, 717] }, { "title": "Vector Buckets", "children": [668, 699, 690, 693, 687, 696] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 424, "character": 13, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L424" } ], "extendedTypes": [ { "type": "reference", "target": -1, "name": "default", "package": "@supabase/storage-js" } ] }, { "id": 531, "name": "StorageVectorsClientOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Configuration options for the Storage Vectors client\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "modifierTags": ["@alpha"] }, "children": [ { "id": 536, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Custom fetch implementation (optional)\nUseful for testing or custom request handling" } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 35, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L35" } ], "type": { "type": "reflection", "declaration": { "id": 537, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 538, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 539, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 540, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 541, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 542, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } ] } }, { "id": 543, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 532, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Custom headers to include in all requests" } ], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 30, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" } ], "type": { "type": "reflection", "declaration": { "id": 533, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 30, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" } ], "indexSignatures": [ { "id": 534, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 30, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30" } ], "parameters": [ { "id": 535, "name": "key", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "string" } } ] } } } ], "groups": [ { "title": "Properties", "children": [536, 532] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 26, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L26" } ] } ], "groups": [ { "title": "Classes", "children": [544, 599, 667] }, { "title": "Interfaces", "children": [531] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts", "line": 1, "character": 0, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L1" } ] }, { "id": 735, "name": "packages/StreamDownloadBuilder", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { "id": 736, "name": "default", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { "id": 737, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 5, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L5" } ], "signatures": [ { "id": 738, "name": "default", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 5, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L5" } ], "parameters": [ { "id": 739, "name": "downloadFn", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 740, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 6, "character": 24, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L6" } ], "signatures": [ { "id": 741, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 6, "character": 24, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L6" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 742, "name": "shouldThrowOnError", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "boolean" } } ], "type": { "type": "reference", "target": 736, "name": "StreamDownloadBuilder", "package": "@supabase/storage-js", "qualifiedName": "default" } } ] }, { "id": 747, "name": "then", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 10, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L10" } ], "signatures": [ { "id": 748, "name": "then", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Attaches callbacks for the resolution and/or rejection of the Promise." } ], "blockTags": [ { "tag": "@returns", "content": [ { "kind": "text", "text": "A Promise for the completion of which ever callback is executed." } ] } ] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 10, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L10" } ], "typeParameters": [ { "id": 749, "name": "TResult1", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 1213, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "ReadableStream" }, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "ReadableStream", "package": "typescript" } ], "name": "DownloadResult", "package": "@supabase/storage-js" } }, { "id": 750, "name": "TResult2", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 751, "name": "onfulfilled", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The callback to execute when the Promise is resolved." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 752, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 12, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L12" } ], "signatures": [ { "id": 753, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 12, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L12" } ], "parameters": [ { "id": 754, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1213, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "ReadableStream" }, "typeArguments": [ { "type": "intrinsic", "name": "any" } ], "name": "ReadableStream", "package": "typescript" } ], "name": "DownloadResult", "package": "@supabase/storage-js" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 749, "name": "TResult1", "package": "@supabase/storage-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 749, "name": "TResult1", "package": "@supabase/storage-js", "refersToTypeParameter": true } ], "name": "PromiseLike", "package": "typescript" } ] } } ] } } ] } }, { "id": 755, "name": "onrejected", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The callback to execute when the Promise is rejected." } ] }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 756, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 14, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L14" } ], "signatures": [ { "id": 757, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 14, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L14" } ], "parameters": [ { "id": 758, "name": "reason", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 750, "name": "TResult2", "package": "@supabase/storage-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 750, "name": "TResult2", "package": "@supabase/storage-js", "refersToTypeParameter": true } ], "name": "PromiseLike", "package": "typescript" } ] } } ] } } ] } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": 749, "name": "TResult1", "package": "@supabase/storage-js", "refersToTypeParameter": true }, { "type": "reference", "target": 750, "name": "TResult2", "package": "@supabase/storage-js", "refersToTypeParameter": true } ] } ], "name": "Promise", "package": "typescript" }, "implementationOf": { "type": "reference", "target": -1, "name": "PromiseLike.then" } } ], "implementationOf": { "type": "reference", "target": -1, "name": "PromiseLike.then" } } ], "groups": [ { "title": "Constructors", "children": [737] }, { "title": "Methods", "children": [747] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 4, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L4" } ], "implementedTypes": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 1213, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "ReadableStream" }, "name": "ReadableStream", "package": "typescript" } ], "name": "DownloadResult", "package": "@supabase/storage-js" } ], "name": "PromiseLike", "package": "typescript" } ] } ], "groups": [ { "title": "Classes", "children": [736] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts", "line": 1, "character": 0, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L1" } ] }, { "id": 761, "name": "packages/VectorBucketApi", "variant": "declaration", "kind": 2, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorBucketApi.ts", "line": 1, "character": 0, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorBucketApi.ts#L1" } ] }, { "id": 825, "name": "packages/VectorDataApi", "variant": "declaration", "kind": 2, "flags": {}, "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorDataApi.ts", "line": 1, "character": 0, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorDataApi.ts#L1" } ] }, { "id": 890, "name": "packages/VectorIndexApi", "variant": "declaration", "kind": 2, "flags": {}, "children": [ { "id": 891, "name": "CreateIndexOptions", "variant": "declaration", "kind": 256, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Options for creating a vector index\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type." } ], "modifierTags": ["@alpha"] }, "children": [ { "id": 894, "name": "dataType", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", "line": 25, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorIndexApi.ts#L25" } ], "type": { "type": "literal", "value": "float32" } }, { "id": 895, "name": "dimension", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", "line": 26, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorIndexApi.ts#L26" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 896, "name": "distanceMetric", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", "line": 27, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorIndexApi.ts#L27" } ], "type": { "type": "reference", "target": 1231, "name": "DistanceMetric", "package": "@supabase/storage-js" } }, { "id": 893, "name": "indexName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", "line": 24, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorIndexApi.ts#L24" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 897, "name": "metadataConfiguration", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", "line": 28, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorIndexApi.ts#L28" } ], "type": { "type": "reference", "target": 1228, "name": "MetadataConfiguration", "package": "@supabase/storage-js" } }, { "id": 892, "name": "vectorBucketName", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [], "modifierTags": ["@alpha"] }, "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", "line": 23, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorIndexApi.ts#L23" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [894, 895, 896, 893, 897, 892] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", "line": 22, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorIndexApi.ts#L22" } ] } ], "groups": [ { "title": "Interfaces", "children": [891] } ], "sources": [ { "fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts", "line": 1, "character": 0, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/storage-js/src/packages/VectorIndexApi.ts#L1" } ] } ], "groups": [ { "title": "Modules", "children": [1, 2, 46, 135, 260, 530, 735, 761, 825, 890] } ], "packageName": "@supabase/storage-js", "readme": [ { "kind": "text", "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase Storage JS SDK

\n\n

JavaScript SDK to interact with Supabase Storage, including file storage and vector embeddings.

\n\n

\n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

\n

\n\n
\n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/storage-js)](https://www.npmjs.com/package/@supabase/storage-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/storage-js)](https://pkg.pr.new/~/supabase/storage-js)\n\n
\n\n## Requirements\n\n- **Node.js 20 or later** (Node.js 18 support dropped as of October 31, 2025)\n- For browser support, all modern browsers are supported\n\n> ⚠️ **Node.js 18 Deprecation Notice**\n>\n> Node.js 18 reached end-of-life on April 30, 2025. As announced in [our deprecation notice](https://github.com/orgs/supabase/discussions/37217), support for Node.js 18 was dropped on October 31, 2025.\n\n## Features\n\n- **File Storage**: Upload, download, list, move, and delete files\n- **Access Control**: Public and private buckets with fine-grained permissions\n- **Signed URLs**: Generate time-limited URLs for secure file access\n- **Image Transformations**: On-the-fly image resizing and optimization\n- **Vector Embeddings**: Store and query high-dimensional embeddings with similarity search\n- **Analytics Buckets**: Iceberg table-based buckets optimized for analytical queries and data processing\n\n## Quick Start Guide\n\n### Installing the module\n\n" }, { "kind": "code", "text": "```bash\nnpm install @supabase/storage-js\n```" }, { "kind": "text", "text": "\n\n### Connecting to the storage backend\n\nThere are two ways to use the Storage SDK:\n\n#### Option 1: Via Supabase Client (Recommended)\n\nIf you're already using " }, { "kind": "code", "text": "`@supabase/supabase-js`" }, { "kind": "text", "text": ", access storage through the client:\n\n" }, { "kind": "code", "text": "```js\nimport { createClient } from '@supabase/supabase-js'\n\n// Use publishable/anon key for frontend applications\nconst supabase = createClient('https://.supabase.co', '')\n\n// Access storage\nconst storage = supabase.storage\n\n// Access different bucket types\nconst regularBucket = storage.from('my-bucket')\nconst vectorBucket = storage.vectors.from('embeddings-bucket')\nconst analyticsBucket = storage.analytics // Analytics API\n```" }, { "kind": "text", "text": "\n\n#### Option 2: Standalone StorageClient\n\nFor backend applications or when you need to bypass Row Level Security:\n\n" }, { "kind": "code", "text": "```js\nimport { StorageClient } from '@supabase/storage-js'\n\nconst STORAGE_URL = 'https://.supabase.co/storage/v1'\nconst SERVICE_KEY = '' // Use secret key for backend operations\n\nconst storageClient = new StorageClient(STORAGE_URL, {\n apikey: SERVICE_KEY,\n Authorization: `Bearer ${SERVICE_KEY}`,\n})\n\n// Access different bucket types\nconst regularBucket = storageClient.from('my-bucket')\nconst vectorBucket = storageClient.vectors.from('embeddings-bucket')\nconst analyticsBucket = storageClient.analytics // Analytics API\n```" }, { "kind": "text", "text": "\n\n> **When to use each approach:**\n>\n> - Use " }, { "kind": "code", "text": "`supabase.storage`" }, { "kind": "text", "text": " when working with other Supabase features (auth, database, etc.) in frontend applications\n> - Use " }, { "kind": "code", "text": "`new StorageClient()`" }, { "kind": "text", "text": " for backend applications, Edge Functions, or when you need to bypass RLS policies\n\n> **Note:** Refer to the [Storage Access Control guide](https://supabase.com/docs/guides/storage/access-control) for detailed information on creating RLS policies.\n\n### Understanding Bucket Types\n\nSupabase Storage supports three types of buckets, each optimized for different use cases:\n\n#### 1. Regular Storage Buckets (File Storage)\n\nStandard buckets for storing files, images, videos, and other assets.\n\n" }, { "kind": "code", "text": "```js\n// Create regular storage bucket\nconst { data, error } = await storageClient.createBucket('my-files', {\n public: false,\n})\n\n// Upload files\nawait storageClient.from('my-files').upload('avatar.png', file)\n```" }, { "kind": "text", "text": "\n\n**Use cases:** User uploads, media assets, documents, backups\n\n#### 2. Vector Buckets (Embeddings Storage)\n\nSpecialized buckets for storing and querying high-dimensional vector embeddings.\n\n" }, { "kind": "code", "text": "```js\n// Create vector bucket\nawait storageClient.vectors.createBucket('embeddings-prod')\n\n// Create index and insert vectors\nconst bucket = storageClient.vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents',\n dimension: 1536,\n distanceMetric: 'cosine',\n})\n```" }, { "kind": "text", "text": "\n\n**Use cases:** Semantic search, AI-powered recommendations, similarity matching\n\n**[See full Vector Embeddings documentation below](#vector-embeddings)**\n\n#### 3. Analytics Buckets\n\nSpecialized buckets using Apache Iceberg table format, optimized for analytical queries and large-scale data processing.\n\n" }, { "kind": "code", "text": "```js\n// Create analytics bucket\nawait storageClient.analytics.createBucket('analytics-data')\n\n// List analytics buckets\nconst { data, error } = await storageClient.analytics.listBuckets()\n\n// Delete analytics bucket\nawait storageClient.analytics.deleteBucket('analytics-data')\n```" }, { "kind": "text", "text": "\n\n**Use cases:** Time-series data, analytical queries, data lakes, large-scale data processing, business intelligence\n\n**[See full Analytics Buckets documentation below](#analytics-buckets)**\n\n---\n\n### Handling resources\n\n#### Handling Storage Buckets\n\n- Create a new Storage bucket:\n\n " }, { "kind": "code", "text": "```js\n const { data, error } = await storageClient.createBucket(\n 'test_bucket', // Bucket name (must be unique)\n { public: false } // Bucket options\n )\n ```" }, { "kind": "text", "text": "\n\n- Retrieve the details of an existing Storage bucket:\n\n " }, { "kind": "code", "text": "```js\n const { data, error } = await storageClient.getBucket('test_bucket')\n ```" }, { "kind": "text", "text": "\n\n- Update a new Storage bucket:\n\n " }, { "kind": "code", "text": "```js\n const { data, error } = await storageClient.updateBucket(\n 'test_bucket', // Bucket name\n { public: false } // Bucket options\n )\n ```" }, { "kind": "text", "text": "\n\n- Remove all objects inside a single bucket:\n\n " }, { "kind": "code", "text": "```js\n const { data, error } = await storageClient.emptyBucket('test_bucket')\n ```" }, { "kind": "text", "text": "\n\n- Delete an existing bucket (a bucket can't be deleted with existing objects inside it):\n\n " }, { "kind": "code", "text": "```js\n const { data, error } = await storageClient.deleteBucket('test_bucket')\n ```" }, { "kind": "text", "text": "\n\n- Retrieve the details of all Storage buckets within an existing project:\n\n " }, { "kind": "code", "text": "```js\n // List all buckets\n const { data, error } = await storageClient.listBuckets()\n\n // List buckets with options (pagination, sorting, search)\n const { data, error } = await storageClient.listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod',\n })\n ```" }, { "kind": "text", "text": "\n\n#### Handling Files\n\n- Upload a file to an existing bucket:\n\n " }, { "kind": "code", "text": "```js\n const fileBody = ... // load your file here\n\n const { data, error } = await storageClient.from('bucket').upload('path/to/file', fileBody)\n ```" }, { "kind": "text", "text": "\n\n > Note: \n > The path in " }, { "kind": "code", "text": "`data.Key`" }, { "kind": "text", "text": " is prefixed by the bucket ID and is not the value which should be passed to the " }, { "kind": "code", "text": "`download`" }, { "kind": "text", "text": " method in order to fetch the file. \n > To fetch the file via the " }, { "kind": "code", "text": "`download`" }, { "kind": "text", "text": " method, use " }, { "kind": "code", "text": "`data.path`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`data.bucketId`" }, { "kind": "text", "text": " as follows:\n >\n > " }, { "kind": "code", "text": "```javascript\n > const { data, error } = await storageClient.from('bucket').upload('/folder/file.txt', fileBody)\n > // check for errors\n > const { data2, error2 } = await storageClient.from(data.bucketId).download(data.path)\n > ```" }, { "kind": "text", "text": "\n\n > Note: The " }, { "kind": "code", "text": "`upload`" }, { "kind": "text", "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-upload).\n\n- Download a file from an exisiting bucket:\n\n " }, { "kind": "code", "text": "```js\n const { data, error } = await storageClient.from('bucket').download('path/to/file')\n ```" }, { "kind": "text", "text": "\n\n- List all the files within a bucket:\n\n " }, { "kind": "code", "text": "```js\n const { data, error } = await storageClient.from('bucket').list('folder')\n ```" }, { "kind": "text", "text": "\n\n > Note: The " }, { "kind": "code", "text": "`list`" }, { "kind": "text", "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-list).\n\n- Replace an existing file at the specified path with a new one:\n\n " }, { "kind": "code", "text": "```js\n const fileBody = ... // load your file here\n\n const { data, error } = await storageClient\n .from('bucket')\n .update('path/to/file', fileBody)\n ```" }, { "kind": "text", "text": "\n\n > Note: The " }, { "kind": "code", "text": "`upload`" }, { "kind": "text", "text": " method also accepts a map of optional parameters. For a complete list see the [Supabase API reference](https://supabase.com/docs/reference/javascript/storage-from-upload).\n\n- Move an existing file:\n\n " }, { "kind": "code", "text": "```js\n const { data, error } = await storageClient\n .from('bucket')\n .move('old/path/to/file', 'new/path/to/file')\n ```" }, { "kind": "text", "text": "\n\n- Delete files within the same bucket:\n\n " }, { "kind": "code", "text": "```js\n const { data, error } = await storageClient.from('bucket').remove(['path/to/file'])\n ```" }, { "kind": "text", "text": "\n\n- Create signed URL to download file without requiring permissions:\n\n " }, { "kind": "code", "text": "```js\n const expireIn = 60\n\n const { data, error } = await storageClient\n .from('bucket')\n .createSignedUrl('path/to/file', expireIn)\n ```" }, { "kind": "text", "text": "\n\n- Retrieve URLs for assets in public buckets:\n\n " }, { "kind": "code", "text": "```js\n const { data, error } = await storageClient.from('public-bucket').getPublicUrl('path/to/file')\n ```" }, { "kind": "text", "text": "\n\n## Analytics Buckets\n\nSupabase Storage provides specialized analytics buckets using Apache Iceberg table format, optimized for analytical workloads and large-scale data processing. These buckets are designed for data lake architectures, time-series data, and business intelligence applications.\n\n### What are Analytics Buckets?\n\nAnalytics buckets use the Apache Iceberg open table format, providing:\n\n- **ACID transactions** for data consistency\n- **Schema evolution** without data rewrites\n- **Time travel** to query historical data\n- **Efficient metadata management** for large datasets\n- **Optimized for analytical queries** rather than individual file operations\n\n### When to Use Analytics Buckets\n\n**Use analytics buckets for:**\n\n- Time-series data (logs, metrics, events)\n- Data lake architectures\n- Business intelligence and reporting\n- Large-scale batch processing\n- Analytical workloads requiring ACID guarantees\n\n**Use regular storage buckets for:**\n\n- User file uploads (images, documents, videos)\n- Individual file management\n- Content delivery\n- Simple object storage needs\n\n### Quick Start\n\nYou can access analytics functionality through the " }, { "kind": "code", "text": "`analytics`" }, { "kind": "text", "text": " property on your storage client:\n\n#### Via Supabase Client\n\n" }, { "kind": "code", "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://your-project.supabase.co', 'your-publishable-key')\n\n// Access analytics operations\nconst analytics = supabase.storage.analytics\n\n// Create an analytics bucket\nconst { data, error } = await analytics.createBucket('analytics-data')\nif (error) {\n console.error('Failed to create analytics bucket:', error.message)\n} else {\n console.log('Created bucket:', data.name)\n}\n```" }, { "kind": "text", "text": "\n\n#### Via StorageClient\n\n" }, { "kind": "code", "text": "```typescript\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storageClient = new StorageClient('https://your-project.supabase.co/storage/v1', {\n apikey: 'YOUR_API_KEY',\n Authorization: 'Bearer YOUR_TOKEN',\n})\n\n// Access analytics operations\nconst analytics = storageClient.analytics\n\n// Create an analytics bucket\nawait analytics.createBucket('analytics-data')\n```" }, { "kind": "text", "text": "\n\n### API Reference\n\n#### Create Analytics Bucket\n\nCreates a new analytics bucket using Iceberg table format:\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await analytics.createBucket('my-analytics-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n} else {\n console.log('Created bucket:', data)\n}\n```" }, { "kind": "text", "text": "\n\n**Returns:**\n\n" }, { "kind": "code", "text": "```typescript\n{\n data: {\n id: string\n type: 'ANALYTICS'\n format: string\n created_at: string\n updated_at: string\n } | null\n error: StorageError | null\n}\n```" }, { "kind": "text", "text": "\n\n#### List Analytics Buckets\n\nRetrieves all analytics buckets in your project with optional filtering and pagination:\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await analytics.listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod',\n})\n\nif (data) {\n console.log(`Found ${data.length} analytics buckets`)\n data.forEach((bucket) => {\n console.log(`- ${bucket.id} (created: ${bucket.created_at})`)\n })\n}\n```" }, { "kind": "text", "text": "\n\n**Parameters:**\n\n- " }, { "kind": "code", "text": "`limit?: number`" }, { "kind": "text", "text": " - Maximum number of buckets to return\n- " }, { "kind": "code", "text": "`offset?: number`" }, { "kind": "text", "text": " - Number of buckets to skip (for pagination)\n- " }, { "kind": "code", "text": "`sortColumn?: 'id' | 'name' | 'created_at' | 'updated_at'`" }, { "kind": "text", "text": " - Column to sort by\n- " }, { "kind": "code", "text": "`sortOrder?: 'asc' | 'desc'`" }, { "kind": "text", "text": " - Sort direction\n- " }, { "kind": "code", "text": "`search?: string`" }, { "kind": "text", "text": " - Search term to filter bucket names\n\n**Returns:**\n\n" }, { "kind": "code", "text": "```typescript\n{\n data: AnalyticBucket[] | null\n error: StorageError | null\n}\n```" }, { "kind": "text", "text": "\n\n**Example with Pagination:**\n\n" }, { "kind": "code", "text": "```typescript\n// Fetch first page\nconst firstPage = await analytics.listBuckets({\n limit: 100,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n})\n\n// Fetch second page\nconst secondPage = await analytics.listBuckets({\n limit: 100,\n offset: 100,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n})\n```" }, { "kind": "text", "text": "\n\n#### Delete Analytics Bucket\n\nDeletes an analytics bucket. The bucket must be empty before deletion.\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await analytics.deleteBucket('old-analytics-bucket')\n\nif (error) {\n console.error('Failed to delete:', error.message)\n} else {\n console.log('Bucket deleted:', data.message)\n}\n```" }, { "kind": "text", "text": "\n\n**Returns:**\n\n" }, { "kind": "code", "text": "```typescript\n{\n data: { message: string } | null\n error: StorageError | null\n}\n```" }, { "kind": "text", "text": "\n\n> **Note:** A bucket cannot be deleted if it contains data. You must empty the bucket first.\n\n#### Get Iceberg Catalog for Advanced Operations\n\nFor advanced operations like creating tables, namespaces, and querying Iceberg metadata, use the " }, { "kind": "code", "text": "`from()`" }, { "kind": "text", "text": " method to get a configured [iceberg-js](https://github.com/supabase/iceberg-js) client:\n\n" }, { "kind": "code", "text": "```typescript\n// Get an Iceberg REST Catalog client for your analytics bucket\nconst catalog = analytics.from('analytics-data')\n\n// Create a namespace\nawait catalog.createNamespace({ namespace: ['default'] }, { properties: { owner: 'data-team' } })\n\n// Create a table with schema\nawait catalog.createTable(\n { namespace: ['default'] },\n {\n name: 'events',\n schema: {\n type: 'struct',\n fields: [\n { id: 1, name: 'id', type: 'long', required: true },\n { id: 2, name: 'timestamp', type: 'timestamp', required: true },\n { id: 3, name: 'user_id', type: 'string', required: false },\n ],\n 'schema-id': 0,\n 'identifier-field-ids': [1],\n },\n 'partition-spec': {\n 'spec-id': 0,\n fields: [],\n },\n 'write-order': {\n 'order-id': 0,\n fields: [],\n },\n properties: {\n 'write.format.default': 'parquet',\n },\n }\n)\n\n// List tables in namespace\nconst tables = await catalog.listTables({ namespace: ['default'] })\nconsole.log(tables) // [{ namespace: ['default'], name: 'events' }]\n\n// Load table metadata\nconst table = await catalog.loadTable({ namespace: ['default'], name: 'events' })\n\n// Update table properties\nawait catalog.updateTable(\n { namespace: ['default'], name: 'events' },\n { properties: { 'read.split.target-size': '134217728' } }\n)\n\n// Drop table\nawait catalog.dropTable({ namespace: ['default'], name: 'events' })\n\n// Drop namespace\nawait catalog.dropNamespace({ namespace: ['default'] })\n```" }, { "kind": "text", "text": "\n\n**Returns:** " }, { "kind": "code", "text": "`IcebergRestCatalog`" }, { "kind": "text", "text": " instance from [iceberg-js](https://github.com/supabase/iceberg-js)\n\n> **Note:** The " }, { "kind": "code", "text": "`from()`" }, { "kind": "text", "text": " method returns an Iceberg REST Catalog client that provides full access to the Apache Iceberg REST API. For complete documentation of available operations, see the [iceberg-js documentation](https://supabase.github.io/iceberg-js/).\n\n### Error Handling\n\nAnalytics buckets use the same error handling pattern as the rest of the Storage SDK:\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await analytics.createBucket('my-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n console.error('Status:', error.status)\n console.error('Status Code:', error.statusCode)\n // Handle error appropriately\n}\n```" }, { "kind": "text", "text": "\n\n#### Throwing Errors\n\nYou can configure the client to throw errors instead of returning them:\n\n" }, { "kind": "code", "text": "```typescript\nconst analytics = storageClient.analytics\nanalytics.throwOnError()\n\ntry {\n const { data } = await analytics.createBucket('my-bucket')\n // data is guaranteed to be present\n console.log('Success:', data)\n} catch (error) {\n if (error instanceof StorageApiError) {\n console.error('API Error:', error.statusCode, error.message)\n }\n}\n```" }, { "kind": "text", "text": "\n\n### TypeScript Types\n\nThe library exports TypeScript types for analytics buckets:\n\n" }, { "kind": "code", "text": "```typescript\nimport type { AnalyticBucket, BucketType, StorageError } from '@supabase/storage-js'\n\n// AnalyticBucket type\ninterface AnalyticBucket {\n id: string\n type: 'ANALYTICS'\n format: string\n created_at: string\n updated_at: string\n}\n```" }, { "kind": "text", "text": "\n\n### Common Patterns\n\n#### Checking if a Bucket Exists\n\n" }, { "kind": "code", "text": "```typescript\nasync function bucketExists(bucketName: string): Promise {\n const { data, error } = await analytics.listBuckets({\n search: bucketName,\n })\n\n if (error) {\n console.error('Error checking bucket:', error.message)\n return false\n }\n\n return data?.some((bucket) => bucket.id === bucketName) ?? false\n}\n```" }, { "kind": "text", "text": "\n\n#### Creating Bucket with Error Handling\n\n" }, { "kind": "code", "text": "```typescript\nasync function ensureAnalyticsBucket(bucketName: string) {\n // Try to create the bucket\n const { data, error } = await analytics.createBucket(bucketName)\n\n if (error) {\n // Check if bucket already exists (conflict error)\n if (error.statusCode === '409') {\n console.log(`Bucket '${bucketName}' already exists`)\n return { success: true, created: false }\n }\n\n // Other error occurred\n console.error('Failed to create bucket:', error.message)\n return { success: false, error }\n }\n\n console.log(`Created new bucket: '${bucketName}'`)\n return { success: true, created: true, data }\n}\n```" }, { "kind": "text", "text": "\n\n#### Listing All Buckets with Pagination\n\n" }, { "kind": "code", "text": "```typescript\nasync function getAllAnalyticsBuckets() {\n const allBuckets: AnalyticBucket[] = []\n let offset = 0\n const limit = 100\n\n while (true) {\n const { data, error } = await analytics.listBuckets({\n limit,\n offset,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n })\n\n if (error) {\n console.error('Error fetching buckets:', error.message)\n break\n }\n\n if (!data || data.length === 0) {\n break\n }\n\n allBuckets.push(...data)\n\n // If we got fewer results than the limit, we've reached the end\n if (data.length < limit) {\n break\n }\n\n offset += limit\n }\n\n return allBuckets\n}\n```" }, { "kind": "text", "text": "\n\n## Vector Embeddings\n\nSupabase Storage provides built-in support for storing and querying high-dimensional vector embeddings, powered by S3 Vectors. This enables semantic search, similarity matching, and AI-powered applications without needing a separate vector database.\n\n> **Note:** Vector embeddings functionality is available in " }, { "kind": "code", "text": "`@supabase/storage-js`" }, { "kind": "text", "text": " v2.76 and later.\n\n### Features\n\n- **Vector Buckets**: Organize vector indexes into logical containers\n- **Vector Indexes**: Define schemas with configurable dimensions and distance metrics\n- **Batch Operations**: Insert/update/delete up to 500 vectors per request\n- **Similarity Search**: Query for nearest neighbors using cosine, euclidean, or dot product distance\n- **Metadata Filtering**: Store and filter vectors by arbitrary JSON metadata\n- **Pagination**: Efficiently scan large vector datasets\n- **Parallel Scanning**: Distribute scans across multiple workers for high throughput\n- **Cross-platform**: Works in Node.js, browsers, and edge runtimes\n\n### Quick Start\n\nYou can access vector functionality in three ways, depending on your use case:\n\n#### Option 1: Via Supabase Client (Most Common)\n\nIf you're using the full Supabase client:\n\n" }, { "kind": "code", "text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://your-project.supabase.co', 'your-publishable-key')\n\n// Access vector operations through storage\nconst vectors = supabase.storage.vectors\n\n// Create a vector bucket\nawait vectors.createBucket('embeddings-prod')\n\n// Create an index\nconst bucket = vectors.from('embeddings-prod')\nawait bucket.createIndex({\n indexName: 'documents-openai',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine',\n})\n\n// Insert vectors\nconst index = bucket.index('documents-openai')\nawait index.putVectors({\n vectors: [\n {\n key: 'doc-1',\n data: { float32: [0.1, 0.2, 0.3 /* ...1536 dimensions */] },\n metadata: { title: 'Introduction', category: 'docs' },\n },\n ],\n})\n\n// Query similar vectors\nconst { data, error } = await index.queryVectors({\n queryVector: { float32: [0.15, 0.25, 0.35 /* ...1536 dimensions */] },\n topK: 5,\n returnDistance: true,\n returnMetadata: true,\n})\n\nif (data) {\n data.matches.forEach((match) => {\n console.log(`${match.key}: distance=${match.distance}`)\n console.log('Metadata:', match.metadata)\n })\n}\n```" }, { "kind": "text", "text": "\n\n#### Option 2: Via StorageClient\n\nIf you're using the standalone " }, { "kind": "code", "text": "`StorageClient`" }, { "kind": "text", "text": " for storage operations, access vectors through the " }, { "kind": "code", "text": "`vectors`" }, { "kind": "text", "text": " property:\n\n" }, { "kind": "code", "text": "```typescript\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storageClient = new StorageClient('https://your-project.supabase.co/storage/v1', {\n apikey: 'YOUR_API_KEY',\n Authorization: 'Bearer YOUR_TOKEN',\n})\n\n// Access vector operations\nconst vectors = storageClient.vectors\n\n// Use the same API as shown in Option 1\nawait vectors.createBucket('embeddings-prod')\nconst bucket = vectors.from('embeddings-prod')\n// ... rest of operations\n```" }, { "kind": "text", "text": "\n\n#### Option 3: Standalone Vector Client\n\nFor vector-only applications that don't need regular file storage operations:\n\n" }, { "kind": "code", "text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\n// Initialize standalone vector client\nconst vectorClient = new StorageVectorsClient('https://your-project.supabase.co/storage/v1', {\n headers: { Authorization: 'Bearer YOUR_TOKEN' },\n})\n\n// Use the same API as shown in Option 1\nawait vectorClient.createBucket('embeddings-prod')\nconst bucket = vectorClient.from('embeddings-prod')\n// ... rest of operations\n```" }, { "kind": "text", "text": "\n\n> **When to use each approach:**\n>\n> - **Option 1**: When using other Supabase features (auth, database, realtime)\n> - **Option 2**: When working with both file storage and vectors\n> - **Option 3**: For dedicated vector-only applications without file storage\n\n### API Reference\n\n#### Client Initialization\n\n" }, { "kind": "code", "text": "```typescript\nconst vectorClient = new StorageVectorsClient(url, options?)\n```" }, { "kind": "text", "text": "\n\n**Options:**\n\n- " }, { "kind": "code", "text": "`headers?: Record`" }, { "kind": "text", "text": " - Custom HTTP headers (e.g., Authorization)\n- " }, { "kind": "code", "text": "`fetch?: Fetch`" }, { "kind": "text", "text": " - Custom fetch implementation\n\n#### Vector Buckets\n\nVector buckets are top-level containers for organizing vector indexes.\n\n##### Create Bucket\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await vectorClient.createBucket('my-bucket')\n```" }, { "kind": "text", "text": "\n\n##### Get Bucket\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await vectorClient.getBucket('my-bucket')\nconsole.log('Created at:', new Date(data.vectorBucket.creationTime! * 1000))\n```" }, { "kind": "text", "text": "\n\n##### List Buckets\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await vectorClient.listBuckets({\n prefix: 'prod-',\n maxResults: 100,\n})\n\n// Pagination\nif (data?.nextToken) {\n const next = await vectorClient.listBuckets({ nextToken: data.nextToken })\n}\n```" }, { "kind": "text", "text": "\n\n##### Delete Bucket\n\n" }, { "kind": "code", "text": "```typescript\n// Bucket must be empty (all indexes deleted first)\nconst { error } = await vectorClient.deleteBucket('my-bucket')\n```" }, { "kind": "text", "text": "\n\n#### Vector Indexes\n\nVector indexes define the schema for embeddings including dimension and distance metric.\n\n##### Create Index\n\n" }, { "kind": "code", "text": "```typescript\nconst bucket = vectorClient.from('my-bucket')\n\nawait bucket.createIndex({\n indexName: 'my-index',\n dataType: 'float32',\n dimension: 1536,\n distanceMetric: 'cosine', // 'cosine' | 'euclidean' | 'dotproduct'\n metadataConfiguration: {\n nonFilterableMetadataKeys: ['raw_text', 'internal_id'],\n },\n})\n```" }, { "kind": "text", "text": "\n\n**Distance Metrics:**\n\n- " }, { "kind": "code", "text": "`cosine`" }, { "kind": "text", "text": " - Cosine similarity (normalized dot product)\n- " }, { "kind": "code", "text": "`euclidean`" }, { "kind": "text", "text": " - Euclidean distance (L2 norm)\n- " }, { "kind": "code", "text": "`dotproduct`" }, { "kind": "text", "text": " - Dot product similarity\n\n##### Get Index\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await bucket.getIndex('my-index')\nconsole.log('Dimension:', data?.index.dimension)\nconsole.log('Distance metric:', data?.index.distanceMetric)\n```" }, { "kind": "text", "text": "\n\n##### List Indexes\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await bucket.listIndexes({\n prefix: 'documents-',\n maxResults: 100,\n})\n```" }, { "kind": "text", "text": "\n\n##### Delete Index\n\n" }, { "kind": "code", "text": "```typescript\n// Deletes index and all its vectors\nawait bucket.deleteIndex('my-index')\n```" }, { "kind": "text", "text": "\n\n#### Vector Operations\n\n##### Insert/Update Vectors (Upsert)\n\n" }, { "kind": "code", "text": "```typescript\nconst index = vectorClient.from('my-bucket').index('my-index')\n\nawait index.putVectors({\n vectors: [\n {\n key: 'unique-id-1',\n data: {\n float32: [\n /* 1536 numbers */\n ],\n },\n metadata: {\n title: 'Document Title',\n category: 'technical',\n page: 1,\n },\n },\n // ... up to 500 vectors per request\n ],\n})\n```" }, { "kind": "text", "text": "\n\n**Limitations:**\n\n- 1-500 vectors per request\n- Vectors must match index dimension\n- Keys must be unique within index\n\n##### Get Vectors by Key\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await index.getVectors({\n keys: ['doc-1', 'doc-2', 'doc-3'],\n returnData: true, // Include embeddings\n returnMetadata: true, // Include metadata\n})\n\ndata?.vectors.forEach((v) => {\n console.log(v.key, v.metadata)\n})\n```" }, { "kind": "text", "text": "\n\n##### Query Similar Vectors (ANN Search)\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await index.queryVectors({\n queryVector: {\n float32: [\n /* 1536 numbers */\n ],\n },\n topK: 10,\n filter: {\n category: 'technical',\n published: true,\n },\n returnDistance: true,\n returnMetadata: true,\n})\n\n// Results ordered by similarity\ndata?.matches.forEach((match) => {\n console.log(`${match.key}: distance=${match.distance}`)\n})\n```" }, { "kind": "text", "text": "\n\n**Filter Syntax:**\nThe " }, { "kind": "code", "text": "`filter`" }, { "kind": "text", "text": " parameter accepts arbitrary JSON for metadata filtering. Non-filterable keys (configured at index creation) cannot be used in filters but can still be returned.\n\n##### List/Scan Vectors\n\n" }, { "kind": "code", "text": "```typescript\n// Simple pagination\nlet nextToken: string | undefined\ndo {\n const { data } = await index.listVectors({\n maxResults: 500,\n nextToken,\n returnMetadata: true,\n })\n\n console.log('Batch:', data?.vectors.length)\n nextToken = data?.nextToken\n} while (nextToken)\n\n// Parallel scanning (4 workers)\nconst workers = [0, 1, 2, 3].map(async (segmentIndex) => {\n const { data } = await index.listVectors({\n segmentCount: 4,\n segmentIndex,\n returnMetadata: true,\n })\n return data?.vectors || []\n})\n\nconst results = await Promise.all(workers)\nconst allVectors = results.flat()\n```" }, { "kind": "text", "text": "\n\n**Limitations:**\n\n- " }, { "kind": "code", "text": "`maxResults`" }, { "kind": "text", "text": ": 1-1000 (default: 500)\n- " }, { "kind": "code", "text": "`segmentCount`" }, { "kind": "text", "text": ": 1-16\n- Response may be limited by 1MB size\n\n##### Delete Vectors\n\n" }, { "kind": "code", "text": "```typescript\nawait index.deleteVectors({\n keys: ['doc-1', 'doc-2', 'doc-3'],\n // ... up to 500 keys per request\n})\n```" }, { "kind": "text", "text": "\n\n### Error Handling\n\nThe library uses a consistent error handling pattern:\n\n" }, { "kind": "code", "text": "```typescript\nconst { data, error } = await vectorClient.createBucket('my-bucket')\n\nif (error) {\n console.error('Error:', error.message)\n console.error('Status:', error.status)\n console.error('Code:', error.statusCode)\n}\n```" }, { "kind": "text", "text": "\n\n#### Error Codes\n\n| Code | HTTP | Description |\n| ---------------------------- | ---- | ----------------------- |\n| " }, { "kind": "code", "text": "`InternalError`" }, { "kind": "text", "text": " | 500 | Internal server error |\n| " }, { "kind": "code", "text": "`S3VectorConflictException`" }, { "kind": "text", "text": " | 409 | Resource already exists |\n| " }, { "kind": "code", "text": "`S3VectorNotFoundException`" }, { "kind": "text", "text": " | 404 | Resource not found |\n| " }, { "kind": "code", "text": "`S3VectorBucketNotEmpty`" }, { "kind": "text", "text": " | 400 | Bucket contains indexes |\n| " }, { "kind": "code", "text": "`S3VectorMaxBucketsExceeded`" }, { "kind": "text", "text": " | 400 | Bucket quota exceeded |\n| " }, { "kind": "code", "text": "`S3VectorMaxIndexesExceeded`" }, { "kind": "text", "text": " | 400 | Index quota exceeded |\n\n#### Throwing Errors\n\nYou can configure the client to throw errors instead:\n\n" }, { "kind": "code", "text": "```typescript\nconst vectorClient = new StorageVectorsClient(url, options)\nvectorClient.throwOnError()\n\ntry {\n const { data } = await vectorClient.createBucket('my-bucket')\n // data is guaranteed to be present\n} catch (error) {\n if (error instanceof StorageVectorsApiError) {\n console.error('API Error:', error.statusCode)\n }\n}\n```" }, { "kind": "text", "text": "\n\n### Advanced Usage\n\n#### Scoped Clients\n\nCreate scoped clients for cleaner code:\n\n" }, { "kind": "code", "text": "```typescript\n// Bucket-scoped operations\nconst bucket = vectorClient.from('embeddings-prod')\nawait bucket.createIndex({\n /* ... */\n})\nawait bucket.listIndexes()\n\n// Index-scoped operations\nconst index = bucket.index('documents-openai')\nawait index.putVectors({\n /* ... */\n})\nawait index.queryVectors({\n /* ... */\n})\n```" }, { "kind": "text", "text": "\n\n#### Custom Fetch\n\nProvide a custom fetch implementation:\n\n" }, { "kind": "code", "text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\nconst vectorClient = new StorageVectorsClient(url, {\n fetch: customFetch,\n headers: {\n /* ... */\n },\n})\n```" }, { "kind": "text", "text": "\n\n#### Batch Processing\n\nProcess large datasets in batches:\n\n" }, { "kind": "code", "text": "```typescript\nasync function insertLargeDataset(vectors: VectorObject[]) {\n const batchSize = 500\n\n for (let i = 0; i < vectors.length; i += batchSize) {\n const batch = vectors.slice(i, i + batchSize)\n await index.putVectors({ vectors: batch })\n console.log(`Inserted ${i + batch.length}/${vectors.length}`)\n }\n}\n```" }, { "kind": "text", "text": "\n\n#### Float32 Validation\n\nEnsure vectors are properly normalized to float32:\n\n" }, { "kind": "code", "text": "```typescript\nimport { normalizeToFloat32 } from '@supabase/storage-js'\n\nconst vector = normalizeToFloat32([0.1, 0.2, 0.3 /* ... */])\n```" }, { "kind": "text", "text": "\n\n### Type Definitions\n\nThe library exports comprehensive TypeScript types:\n\n" }, { "kind": "code", "text": "```typescript\nimport type {\n VectorBucket,\n VectorIndex,\n VectorData,\n VectorObject,\n VectorMatch,\n VectorMetadata,\n DistanceMetric,\n ApiResponse,\n StorageVectorsError,\n} from '@supabase/storage-js'\n```" }, { "kind": "text", "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n#### Build Scripts Overview\n\n" }, { "kind": "code", "text": "```bash\n# Build the package\nnpx nx build storage-js\n\n# Watch mode for development\nnpx nx build storage-js --watch\n\n# Generate documentation\nnpx nx docs storage-js\n```" }, { "kind": "text", "text": "\n\n### Testing\n\n**Important:** The storage-js tests require a local Supabase stack running via the Supabase CLI. Docker must be running since the Supabase CLI uses it internally.\n\n#### Prerequisites\n\n1. **Docker** must be installed and running (used by Supabase CLI internally)\n2. **Supabase CLI** — installed automatically via " }, { "kind": "code", "text": "`npx supabase`" }, { "kind": "text", "text": "\n\n#### Test Scripts Overview\n\n| Script | Description | What it does |\n| ----------------- | --------------------------------- | ----------------------------------------------------------------- |\n| " }, { "kind": "code", "text": "`test:storage`" }, { "kind": "text", "text": " | **Complete test workflow** | Runs the full test cycle: clean → start infra → run tests → clean |\n| " }, { "kind": "code", "text": "`test:suite`" }, { "kind": "text", "text": " | **Jest tests only** | Runs Jest tests with coverage (requires infra to be running) |\n| " }, { "kind": "code", "text": "`test:infra`" }, { "kind": "text", "text": " | **Start test infrastructure** | Starts Supabase CLI stack (PostgreSQL, Storage API, Kong, etc.) |\n| " }, { "kind": "code", "text": "`test:clean-post`" }, { "kind": "text", "text": " | **Stop and clean infrastructure** | Stops the Supabase CLI stack |\n\n#### Running Tests\n\n##### Option 1: Complete Test Run (Recommended)\n\nThis handles everything automatically - starting infrastructure, running tests, and cleaning up:\n\n" }, { "kind": "code", "text": "```bash\n# From monorepo root\nnpx nx test:storage storage-js\n```" }, { "kind": "text", "text": "\n\nThis command will:\n\n1. Stop any existing test containers\n2. Build and start fresh test infrastructure\n3. Wait for services to be ready\n4. Run all Jest tests with coverage\n5. Clean up all containers after tests complete\n\n##### Option 2: Manual Infrastructure Management\n\nUseful for development when you want to run tests multiple times without restarting Docker:\n\n" }, { "kind": "code", "text": "```bash\n# Step 1: Start the test infrastructure\n# From root\nnpx nx test:infra storage-js\n# This starts: PostgreSQL, Storage API, Kong Gateway, and imgproxy\n\n# Step 2: Run tests (can run multiple times)\nnpx nx test:suite storage-js\n\n# Step 3: When done, clean up the infrastructure\nnpx nx test:clean-post storage-js\n```" }, { "kind": "text", "text": "\n\n##### Option 3: Development Mode\n\nFor actively developing and debugging tests:\n\n" }, { "kind": "code", "text": "```bash\n# Start infrastructure once (from root)\nnpx nx test:infra storage-js\n\n# Run tests in watch mode\nnpx nx test:suite storage-js --watch\n\n# Clean up when done\nnpx nx test:clean-post storage-js\n```" }, { "kind": "text", "text": "\n\n#### Test Infrastructure Details\n\nThe test infrastructure is managed via the Supabase CLI (" }, { "kind": "code", "text": "`npx supabase start --workdir test`" }, { "kind": "text", "text": "), which starts a local Supabase stack defined by the config in " }, { "kind": "code", "text": "`test/`" }, { "kind": "text", "text": ". This includes PostgreSQL, the Storage API, Kong Gateway, and supporting services.\n\n#### Common Issues and Solutions\n\n| Issue | Solution |\n| --------------------------------- | ------------------------------------------------------------------------------------------------ |\n| Port conflicts | Another service is using a required port. Run " }, { "kind": "code", "text": "`npx nx test:clean-post storage-js`" }, { "kind": "text", "text": " then try again |\n| \"request failed, reason:\" errors | Infrastructure isn't running. Run " }, { "kind": "code", "text": "`npx nx test:infra storage-js`" }, { "kind": "text", "text": " first |\n| Tests fail with connection errors | Ensure Docker is running (Supabase CLI requires Docker) |\n| Stack already running | Run " }, { "kind": "code", "text": "`npx nx test:clean-post storage-js`" }, { "kind": "text", "text": " to stop it before restarting |\n\n#### Understanding Test Failures\n\n- **StorageUnknownError with \"request failed\"**: Infrastructure not running\n- **Snapshot failures**: Expected test data has changed — review and update snapshots if needed\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" }, { "kind": "relative-link", "text": "../../../CONTRIBUTING.md", "target": 11 }, { "kind": "text", "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes." } ], "symbolIdMap": { "1": { "sourceFileName": "src/index.ts", "qualifiedName": "" }, "2": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "" }, "3": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default" }, "4": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default.__constructor" }, "5": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default" }, "6": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "downloadFn" }, "7": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "__type" }, "8": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "__type" }, "9": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "shouldThrowOnError" }, "15": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default.asStream" }, "16": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default.asStream" }, "17": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default.then" }, "18": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default.then" }, "19": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "TResult1" }, "20": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "TResult2" }, "21": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "onfulfilled" }, "22": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "__type" }, "23": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "__type" }, "24": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "value" }, "25": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "onrejected" }, "26": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "__type" }, "27": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "__type" }, "28": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "reason" }, "29": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default.catch" }, "30": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default.catch" }, "31": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "TResult" }, "32": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "onrejected" }, "33": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "__type" }, "34": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "__type" }, "35": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "reason" }, "36": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default.finally" }, "37": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default.finally" }, "38": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "onfinally" }, "39": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "__type" }, "40": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "__type" }, "45": { "sourceFileName": "src/packages/BlobDownloadBuilder.ts", "qualifiedName": "default.[toStringTag]" }, "46": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "" }, "47": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "WrappedIcebergRestCatalog" }, "48": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "default" }, "49": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "default.__constructor" }, "50": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "default" }, "51": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "url" }, "52": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "headers" }, "53": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type" }, "54": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.__index" }, "56": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "fetch" }, "57": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "58": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "59": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "60": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "61": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "62": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "63": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "64": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "default.createBucket" }, "65": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "default.createBucket" }, "66": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "name" }, "67": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type" }, "68": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.data" }, "69": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.error" }, "70": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type" }, "71": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.data" }, "72": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.error" }, "73": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "default.listBuckets" }, "74": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "default.listBuckets" }, "75": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "options" }, "76": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type" }, "77": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.limit" }, "78": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.offset" }, "79": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.sortColumn" }, "80": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.sortOrder" }, "81": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.search" }, "82": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type" }, "83": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.data" }, "84": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.error" }, "85": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type" }, "86": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.data" }, "87": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.error" }, "88": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "default.deleteBucket" }, "89": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "default.deleteBucket" }, "90": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "bucketName" }, "91": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type" }, "92": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.data" }, "93": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type" }, "94": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.message" }, "95": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.error" }, "96": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type" }, "97": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.data" }, "98": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "__type.error" }, "99": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "default.from" }, "100": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "default.from" }, "101": { "sourceFileName": "src/packages/StorageAnalyticsClient.ts", "qualifiedName": "bucketName" }, "117": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "118": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "119": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "120": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "121": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "name" }, "122": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "value" }, "135": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "" }, "136": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default" }, "137": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.__constructor" }, "138": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default" }, "139": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "url" }, "140": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "headers" }, "141": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "142": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.__index" }, "144": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "fetch" }, "145": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "146": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "147": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "148": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "149": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "150": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "151": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "152": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "opts" }, "153": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.listBuckets" }, "154": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.listBuckets" }, "155": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "options" }, "156": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "157": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "158": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "159": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "160": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "161": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "162": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.getBucket" }, "163": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.getBucket" }, "164": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "id" }, "165": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "166": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "167": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "168": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "169": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "170": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "171": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.createBucket" }, "172": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.createBucket" }, "173": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "id" }, "174": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "options" }, "175": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "176": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.public" }, "177": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.fileSizeLimit" }, "178": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.allowedMimeTypes" }, "179": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.type" }, "180": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "181": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "182": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "183": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "184": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "185": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "186": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.updateBucket" }, "187": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.updateBucket" }, "188": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "id" }, "189": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "options" }, "190": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "191": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.public" }, "192": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.fileSizeLimit" }, "193": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.allowedMimeTypes" }, "194": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "195": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "196": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "197": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.message" }, "198": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "199": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "200": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "201": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "202": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.emptyBucket" }, "203": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.emptyBucket" }, "204": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "id" }, "205": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "206": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "207": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "208": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.message" }, "209": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "210": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "211": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "212": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "213": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.deleteBucket" }, "214": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.deleteBucket" }, "215": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "id" }, "216": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "217": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "218": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "219": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.message" }, "220": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "221": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "222": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "223": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "242": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "243": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "244": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "245": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "246": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "name" }, "247": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "value" }, "260": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "" }, "261": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default" }, "262": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.__constructor" }, "263": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default" }, "264": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "url" }, "265": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "headers" }, "266": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "267": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.__index" }, "269": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "bucketId" }, "270": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "fetch" }, "271": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "272": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "273": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "274": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "275": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "276": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "277": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "295": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.upload" }, "296": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.upload" }, "297": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "path" }, "298": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "fileBody" }, "299": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "fileOptions" }, "300": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "301": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "302": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "303": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.id" }, "304": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.path" }, "305": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.fullPath" }, "306": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "307": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "308": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "309": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "310": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.uploadToSignedUrl" }, "311": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.uploadToSignedUrl" }, "312": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "path" }, "313": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "token" }, "314": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "fileBody" }, "315": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "fileOptions" }, "316": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "__type" }, "317": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "__type.data" }, "318": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "__type.error" }, "319": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "__type" }, "320": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "__type.data" }, "321": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__object" }, "322": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__object.path" }, "323": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__object.fullPath" }, "324": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "__type.error" }, "325": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.createSignedUploadUrl" }, "326": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.createSignedUploadUrl" }, "327": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "path" }, "328": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "options" }, "329": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "330": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.upsert" }, "331": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "332": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "333": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "334": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.signedUrl" }, "335": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.token" }, "336": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.path" }, "337": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "338": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "339": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "340": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "341": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.update" }, "342": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.update" }, "343": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "path" }, "344": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "fileBody" }, "345": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "fileOptions" }, "346": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "347": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "348": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "349": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.id" }, "350": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.path" }, "351": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.fullPath" }, "352": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "353": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "354": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "355": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "356": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.move" }, "357": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.move" }, "358": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "fromPath" }, "359": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "toPath" }, "360": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "options" }, "361": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "362": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "363": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "364": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.message" }, "365": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "366": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "367": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "368": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "369": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.copy" }, "370": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.copy" }, "371": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "fromPath" }, "372": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "toPath" }, "373": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "options" }, "374": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "375": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "376": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "377": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.path" }, "378": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "379": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "380": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "381": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "382": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.createSignedUrl" }, "383": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.createSignedUrl" }, "384": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "path" }, "385": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "expiresIn" }, "386": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "options" }, "387": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "388": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.download" }, "389": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.transform" }, "390": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "391": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "392": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "393": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.signedUrl" }, "394": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "395": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "396": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "397": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "398": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.createSignedUrls" }, "399": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.createSignedUrls" }, "400": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "paths" }, "401": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "expiresIn" }, "402": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "options" }, "403": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "404": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.download" }, "405": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "406": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "407": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "408": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "409": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.path" }, "410": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.signedUrl" }, "411": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "412": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "413": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "414": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "415": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.download" }, "416": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.download" }, "417": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "Options" }, "418": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "419": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.transform" }, "420": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "path" }, "421": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "options" }, "422": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "parameters" }, "423": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.info" }, "424": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.info" }, "425": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "path" }, "426": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "427": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "428": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "429": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "430": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "431": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "432": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.exists" }, "433": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.exists" }, "434": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "path" }, "435": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "436": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "437": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "438": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "439": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "440": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "441": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.getPublicUrl" }, "442": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.getPublicUrl" }, "443": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "path" }, "444": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "options" }, "445": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "446": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.download" }, "447": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.transform" }, "448": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "449": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "450": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "451": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.publicUrl" }, "452": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.remove" }, "453": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.remove" }, "454": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "paths" }, "455": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "456": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "457": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "458": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "459": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "460": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "461": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.list" }, "462": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.list" }, "463": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "path" }, "464": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "options" }, "465": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "parameters" }, "466": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "467": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "468": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "469": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "470": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "471": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "472": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.listV2" }, "473": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.listV2" }, "474": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "options" }, "475": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "parameters" }, "476": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "477": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "478": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "479": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type" }, "480": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.data" }, "481": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "__type.error" }, "485": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.toBase64" }, "486": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "default.toBase64" }, "487": { "sourceFileName": "src/packages/StorageFileApi.ts", "qualifiedName": "data" }, "512": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "513": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "514": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "515": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "516": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "name" }, "517": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "value" }, "530": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "" }, "531": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClientOptions" }, "532": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClientOptions.headers" }, "533": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "__type" }, "534": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "__type.__index" }, "536": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClientOptions.fetch" }, "537": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "538": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "539": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "540": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "541": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "542": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "543": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "544": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient" }, "545": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient.__constructor" }, "546": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient" }, "547": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "url" }, "548": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "options" }, "549": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient.from" }, "550": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient.from" }, "551": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "vectorBucketName" }, "552": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient.createBucket" }, "553": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient.createBucket" }, "554": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "vectorBucketName" }, "555": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient.getBucket" }, "556": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient.getBucket" }, "557": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "vectorBucketName" }, "558": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "__type" }, "559": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "__type.vectorBucket" }, "560": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient.listBuckets" }, "561": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient.listBuckets" }, "562": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "options" }, "563": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient.deleteBucket" }, "564": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "StorageVectorsClient.deleteBucket" }, "565": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "vectorBucketName" }, "581": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "582": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "583": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "584": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "585": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "name" }, "586": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "value" }, "599": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope" }, "600": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope.__constructor" }, "601": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope" }, "602": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "url" }, "603": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "headers" }, "604": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "__type" }, "605": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "__type.__index" }, "607": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "vectorBucketName" }, "608": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "fetch" }, "609": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "610": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "611": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "612": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "613": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "614": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "615": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "617": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope.createIndex" }, "618": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope.createIndex" }, "619": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "options" }, "620": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope.listIndexes" }, "621": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope.listIndexes" }, "622": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "options" }, "623": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope.getIndex" }, "624": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope.getIndex" }, "625": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "indexName" }, "626": { "sourceFileName": "src/packages/VectorIndexApi.ts", "qualifiedName": "__type" }, "627": { "sourceFileName": "src/packages/VectorIndexApi.ts", "qualifiedName": "__type.index" }, "628": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope.deleteIndex" }, "629": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope.deleteIndex" }, "630": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "indexName" }, "631": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope.index" }, "632": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorBucketScope.index" }, "633": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "indexName" }, "649": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "650": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "651": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "652": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "653": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "name" }, "654": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "value" }, "667": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope" }, "668": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope.__constructor" }, "669": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope" }, "670": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "url" }, "671": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "headers" }, "672": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "__type" }, "673": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "__type.__index" }, "675": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "vectorBucketName" }, "676": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "indexName" }, "677": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "fetch" }, "678": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "679": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "680": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "681": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "682": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "683": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "684": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "687": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope.putVectors" }, "688": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope.putVectors" }, "689": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "options" }, "690": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope.getVectors" }, "691": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope.getVectors" }, "692": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "options" }, "693": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope.listVectors" }, "694": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope.listVectors" }, "695": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "options" }, "696": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope.queryVectors" }, "697": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope.queryVectors" }, "698": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "options" }, "699": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope.deleteVectors" }, "700": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "VectorIndexScope.deleteVectors" }, "701": { "sourceFileName": "src/packages/StorageVectorsClient.ts", "qualifiedName": "options" }, "717": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "718": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "719": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "720": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "721": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "name" }, "722": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "value" }, "735": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "" }, "736": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "default" }, "737": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "default.__constructor" }, "738": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "default" }, "739": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "downloadFn" }, "740": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "__type" }, "741": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "__type" }, "742": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "shouldThrowOnError" }, "747": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "default.then" }, "748": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "default.then" }, "749": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "TResult1" }, "750": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "TResult2" }, "751": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "onfulfilled" }, "752": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "__type" }, "753": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "__type" }, "754": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "value" }, "755": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "onrejected" }, "756": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "__type" }, "757": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "__type" }, "758": { "sourceFileName": "src/packages/StreamDownloadBuilder.ts", "qualifiedName": "reason" }, "761": { "sourceFileName": "src/packages/VectorBucketApi.ts", "qualifiedName": "" }, "825": { "sourceFileName": "src/packages/VectorDataApi.ts", "qualifiedName": "" }, "890": { "sourceFileName": "src/packages/VectorIndexApi.ts", "qualifiedName": "" }, "891": { "sourceFileName": "src/packages/VectorIndexApi.ts", "qualifiedName": "CreateIndexOptions" }, "892": { "sourceFileName": "src/packages/VectorIndexApi.ts", "qualifiedName": "CreateIndexOptions.vectorBucketName" }, "893": { "sourceFileName": "src/packages/VectorIndexApi.ts", "qualifiedName": "CreateIndexOptions.indexName" }, "894": { "sourceFileName": "src/packages/VectorIndexApi.ts", "qualifiedName": "CreateIndexOptions.dataType" }, "895": { "sourceFileName": "src/packages/VectorIndexApi.ts", "qualifiedName": "CreateIndexOptions.dimension" }, "896": { "sourceFileName": "src/packages/VectorIndexApi.ts", "qualifiedName": "CreateIndexOptions.distanceMetric" }, "897": { "sourceFileName": "src/packages/VectorIndexApi.ts", "qualifiedName": "CreateIndexOptions.metadataConfiguration" }, "963": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "StorageClient" }, "964": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "StorageClient.__constructor" }, "965": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "StorageClient" }, "966": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "url" }, "967": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "headers" }, "968": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "__type" }, "969": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "__type.__index" }, "971": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "fetch" }, "972": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "973": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "974": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "975": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "976": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "977": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "978": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "979": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "opts" }, "980": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "StorageClient.from" }, "981": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "StorageClient.from" }, "982": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "id" }, "983": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "StorageClient.vectors" }, "984": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "StorageClient.vectors" }, "985": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "StorageClient.analytics" }, "986": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "StorageClient.analytics" }, "987": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.listBuckets" }, "988": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.listBuckets" }, "989": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "options" }, "990": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "991": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "992": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "993": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "994": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "995": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "996": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.getBucket" }, "997": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.getBucket" }, "998": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "id" }, "999": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1000": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "1001": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "1002": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1003": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "1004": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "1005": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.createBucket" }, "1006": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.createBucket" }, "1007": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "id" }, "1008": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "options" }, "1009": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1010": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.public" }, "1011": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.fileSizeLimit" }, "1012": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.allowedMimeTypes" }, "1013": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.type" }, "1014": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1015": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "1016": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "1017": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1018": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "1019": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "1020": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.updateBucket" }, "1021": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.updateBucket" }, "1022": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "id" }, "1023": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "options" }, "1024": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1025": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.public" }, "1026": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.fileSizeLimit" }, "1027": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.allowedMimeTypes" }, "1028": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1029": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "1030": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1031": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.message" }, "1032": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "1033": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1034": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "1035": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "1036": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.emptyBucket" }, "1037": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.emptyBucket" }, "1038": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "id" }, "1039": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1040": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "1041": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1042": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.message" }, "1043": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "1044": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1045": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "1046": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "1047": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.deleteBucket" }, "1048": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "default.deleteBucket" }, "1049": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "id" }, "1050": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1051": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "1052": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1053": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.message" }, "1054": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "1055": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type" }, "1056": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.data" }, "1057": { "sourceFileName": "src/packages/StorageBucketApi.ts", "qualifiedName": "__type.error" }, "1073": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "1074": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.throwOnError" }, "1075": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "1076": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "default.setHeader" }, "1077": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "name" }, "1078": { "sourceFileName": "src/lib/common/BaseApiClient.ts", "qualifiedName": "value" }, "1091": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "StorageClientOptions" }, "1092": { "sourceFileName": "src/StorageClient.ts", "qualifiedName": "StorageClientOptions.useNewHostname" }, "1093": { "sourceFileName": "src/index.ts", "qualifiedName": "StorageAnalyticsClient" }, "1094": { "sourceFileName": "src/index.ts", "qualifiedName": "StorageVectorsClient" }, "1095": { "sourceFileName": "src/index.ts", "qualifiedName": "VectorBucketScope" }, "1096": { "sourceFileName": "src/index.ts", "qualifiedName": "VectorIndexScope" }, "1097": { "sourceFileName": "src/index.ts", "qualifiedName": "StorageVectorsClientOptions" }, "1101": { "sourceFileName": "src/index.ts", "qualifiedName": "CreateIndexOptions" }, "1102": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "BucketType" }, "1103": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Bucket" }, "1104": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Bucket.id" }, "1105": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Bucket.type" }, "1106": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Bucket.name" }, "1107": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Bucket.owner" }, "1108": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Bucket.file_size_limit" }, "1109": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Bucket.allowed_mime_types" }, "1110": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Bucket.created_at" }, "1111": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Bucket.updated_at" }, "1112": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Bucket.public" }, "1113": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListBucketOptions" }, "1114": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListBucketOptions.limit" }, "1115": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListBucketOptions.offset" }, "1116": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListBucketOptions.sortColumn" }, "1117": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListBucketOptions.sortOrder" }, "1118": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListBucketOptions.search" }, "1119": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AnalyticBucket" }, "1120": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AnalyticBucket.name" }, "1121": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AnalyticBucket.type" }, "1122": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AnalyticBucket.format" }, "1123": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AnalyticBucket.created_at" }, "1124": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "AnalyticBucket.updated_at" }, "1125": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileMetadata" }, "1126": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileMetadata.eTag" }, "1127": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileMetadata.size" }, "1128": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileMetadata.mimetype" }, "1129": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileMetadata.cacheControl" }, "1130": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileMetadata.lastModified" }, "1131": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileMetadata.contentLength" }, "1132": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileMetadata.httpStatusCode" }, "1133": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileMetadata.__index" }, "1135": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObject" }, "1136": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObject.name" }, "1137": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObject.id" }, "1138": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObject.updated_at" }, "1139": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObject.created_at" }, "1140": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObject.last_accessed_at" }, "1141": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObject.metadata" }, "1142": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObject.bucket_id" }, "1143": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObject.owner" }, "1144": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObject.buckets" }, "1145": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2" }, "1146": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.id" }, "1147": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.version" }, "1148": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.name" }, "1149": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.bucket_id" }, "1150": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.created_at" }, "1151": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.size" }, "1152": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.cache_control" }, "1153": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.content_type" }, "1154": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.etag" }, "1155": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.last_modified" }, "1156": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.metadata" }, "1157": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileObjectV2.updated_at" }, "1158": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SortBy" }, "1159": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SortBy.column" }, "1160": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SortBy.order" }, "1161": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileOptions" }, "1162": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileOptions.cacheControl" }, "1163": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileOptions.contentType" }, "1164": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileOptions.upsert" }, "1165": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileOptions.duplex" }, "1166": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileOptions.metadata" }, "1167": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FileOptions.headers" }, "1168": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "DestinationOptions" }, "1169": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "DestinationOptions.destinationBucket" }, "1170": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchOptions" }, "1171": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchOptions.limit" }, "1172": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchOptions.offset" }, "1173": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchOptions.sortBy" }, "1174": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchOptions.search" }, "1175": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SortByV2" }, "1176": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SortByV2.column" }, "1177": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SortByV2.order" }, "1178": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Options" }, "1179": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Options.limit" }, "1180": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Options.prefix" }, "1181": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Options.cursor" }, "1182": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Options.with_delimiter" }, "1183": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Options.sortBy" }, "1184": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Object" }, "1185": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Object.name" }, "1186": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Object.key" }, "1187": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Object.id" }, "1188": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Object.updated_at" }, "1189": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Object.created_at" }, "1190": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Object.metadata" }, "1191": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Object.last_accessed_at" }, "1192": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Folder" }, "1193": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Folder.name" }, "1194": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Folder.key" }, "1195": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Result" }, "1196": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Result.hasNext" }, "1197": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Result.folders" }, "1198": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Result.objects" }, "1199": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SearchV2Result.nextCursor" }, "1200": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FetchParameters" }, "1201": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FetchParameters.signal" }, "1202": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "FetchParameters.cache" }, "1203": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Metadata" }, "1204": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Metadata.name" }, "1205": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "TransformOptions" }, "1206": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "TransformOptions.width" }, "1207": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "TransformOptions.height" }, "1208": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "TransformOptions.resize" }, "1209": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "TransformOptions.quality" }, "1210": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "TransformOptions.format" }, "1211": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "Camelize" }, "1212": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "T" }, "1213": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "DownloadResult" }, "1214": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1215": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "1216": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "1217": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1218": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.data" }, "1219": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.error" }, "1220": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "T" }, "1221": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "EncryptionConfiguration" }, "1222": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "EncryptionConfiguration.kmsKeyArn" }, "1223": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "EncryptionConfiguration.sseType" }, "1224": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorBucket" }, "1225": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorBucket.vectorBucketName" }, "1226": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorBucket.creationTime" }, "1227": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorBucket.encryptionConfiguration" }, "1228": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MetadataConfiguration" }, "1229": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "MetadataConfiguration.nonFilterableMetadataKeys" }, "1230": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorDataType" }, "1231": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "DistanceMetric" }, "1232": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorIndex" }, "1233": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorIndex.indexName" }, "1234": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorIndex.vectorBucketName" }, "1235": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorIndex.dataType" }, "1236": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorIndex.dimension" }, "1237": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorIndex.distanceMetric" }, "1238": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorIndex.metadataConfiguration" }, "1239": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorIndex.creationTime" }, "1240": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorData" }, "1241": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorData.float32" }, "1242": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorMetadata" }, "1243": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorObject" }, "1244": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorObject.key" }, "1245": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorObject.data" }, "1246": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorObject.metadata" }, "1247": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorMatch" }, "1248": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorMatch.key" }, "1249": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorMatch.data" }, "1250": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorMatch.metadata" }, "1251": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorMatch.distance" }, "1252": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorBucketsOptions" }, "1253": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorBucketsOptions.prefix" }, "1254": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorBucketsOptions.maxResults" }, "1255": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorBucketsOptions.nextToken" }, "1256": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorBucketsResponse" }, "1257": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorBucketsResponse.vectorBuckets" }, "1258": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1259": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.vectorBucketName" }, "1260": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorBucketsResponse.nextToken" }, "1261": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListIndexesOptions" }, "1262": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListIndexesOptions.vectorBucketName" }, "1263": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListIndexesOptions.prefix" }, "1264": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListIndexesOptions.maxResults" }, "1265": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListIndexesOptions.nextToken" }, "1266": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListIndexesResponse" }, "1267": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListIndexesResponse.indexes" }, "1268": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type" }, "1269": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "__type.indexName" }, "1270": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListIndexesResponse.nextToken" }, "1271": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GetVectorsOptions" }, "1272": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GetVectorsOptions.vectorBucketName" }, "1273": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GetVectorsOptions.indexName" }, "1274": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GetVectorsOptions.keys" }, "1275": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GetVectorsOptions.returnData" }, "1276": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GetVectorsOptions.returnMetadata" }, "1277": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GetVectorsResponse" }, "1278": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "GetVectorsResponse.vectors" }, "1279": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "PutVectorsOptions" }, "1280": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "PutVectorsOptions.vectorBucketName" }, "1281": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "PutVectorsOptions.indexName" }, "1282": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "PutVectorsOptions.vectors" }, "1283": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "DeleteVectorsOptions" }, "1284": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "DeleteVectorsOptions.vectorBucketName" }, "1285": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "DeleteVectorsOptions.indexName" }, "1286": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "DeleteVectorsOptions.keys" }, "1287": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsOptions" }, "1288": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsOptions.vectorBucketName" }, "1289": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsOptions.indexName" }, "1290": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsOptions.maxResults" }, "1291": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsOptions.nextToken" }, "1292": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsOptions.returnData" }, "1293": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsOptions.returnMetadata" }, "1294": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsOptions.segmentCount" }, "1295": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsOptions.segmentIndex" }, "1296": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsResponse" }, "1297": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsResponse.vectors" }, "1298": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ListVectorsResponse.nextToken" }, "1299": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorFilter" }, "1300": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "QueryVectorsOptions" }, "1301": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "QueryVectorsOptions.vectorBucketName" }, "1302": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "QueryVectorsOptions.indexName" }, "1303": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "QueryVectorsOptions.queryVector" }, "1304": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "QueryVectorsOptions.topK" }, "1305": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "QueryVectorsOptions.filter" }, "1306": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "QueryVectorsOptions.returnDistance" }, "1307": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "QueryVectorsOptions.returnMetadata" }, "1308": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "QueryVectorsResponse" }, "1309": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "QueryVectorsResponse.vectors" }, "1310": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "QueryVectorsResponse.distanceMetric" }, "1311": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorFetchParameters" }, "1312": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "VectorFetchParameters.signal" }, "1313": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SuccessResponse" }, "1314": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SuccessResponse.data" }, "1315": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SuccessResponse.error" }, "1316": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "SuccessResponse.T" }, "1317": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ErrorResponse" }, "1318": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ErrorResponse.data" }, "1319": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ErrorResponse.error" }, "1320": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "ApiResponse" }, "1321": { "sourceFileName": "src/lib/types.ts", "qualifiedName": "T" }, "1322": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "isStorageError" }, "1323": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "isStorageError" }, "1324": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "error" }, "1325": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "isStorageVectorsError" }, "1326": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "isStorageVectorsError" }, "1327": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "error" }, "1328": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "ErrorNamespace" }, "1329": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageError" }, "1330": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageError.__constructor" }, "1331": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageError" }, "1332": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "message" }, "1333": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "namespace" }, "1334": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "status" }, "1335": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "statusCode" }, "1338": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageError.status" }, "1339": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageError.statusCode" }, "1340": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageApiError" }, "1341": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageApiError.__constructor" }, "1342": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageApiError" }, "1343": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "message" }, "1344": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "status" }, "1345": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "statusCode" }, "1346": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "namespace" }, "1347": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageApiError.status" }, "1348": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageApiError.statusCode" }, "1349": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageApiError.toJSON" }, "1350": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageApiError.toJSON" }, "1351": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "__object" }, "1352": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "__object.name" }, "1353": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "__object.message" }, "1354": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "__object.status" }, "1355": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "__object.statusCode" }, "1358": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageUnknownError" }, "1359": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageUnknownError.__constructor" }, "1360": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageUnknownError" }, "1361": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "message" }, "1362": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "originalError" }, "1363": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "namespace" }, "1364": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageUnknownError.originalError" }, "1367": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageError.status" }, "1368": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageError.statusCode" }, "1369": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsError" }, "1370": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsError.__constructor" }, "1371": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsError" }, "1372": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "message" }, "1375": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageError.status" }, "1376": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageError.statusCode" }, "1377": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsApiError" }, "1378": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsApiError.__constructor" }, "1379": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsApiError" }, "1380": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "message" }, "1381": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "status" }, "1382": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "statusCode" }, "1383": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageApiError.status" }, "1384": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageApiError.statusCode" }, "1385": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageApiError.toJSON" }, "1386": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageApiError.toJSON" }, "1387": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "__object" }, "1388": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "__object.name" }, "1389": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "__object.message" }, "1390": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "__object.status" }, "1391": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "__object.statusCode" }, "1394": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsUnknownError" }, "1395": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsUnknownError.__constructor" }, "1396": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsUnknownError" }, "1397": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "message" }, "1398": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "originalError" }, "1399": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageUnknownError.originalError" }, "1402": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageError.status" }, "1403": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageError.statusCode" }, "1404": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsErrorCode" }, "1405": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsErrorCode.InternalError" }, "1406": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsErrorCode.S3VectorConflictException" }, "1407": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsErrorCode.S3VectorNotFoundException" }, "1408": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsErrorCode.S3VectorBucketNotEmpty" }, "1409": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsErrorCode.S3VectorMaxBucketsExceeded" }, "1410": { "sourceFileName": "src/lib/common/errors.ts", "qualifiedName": "StorageVectorsErrorCode.S3VectorMaxIndexesExceeded" } }, "files": { "entries": { "1": "src/index.ts", "2": "src/packages/BlobDownloadBuilder.ts", "3": "src/packages/StorageAnalyticsClient.ts", "4": "src/packages/StorageBucketApi.ts", "5": "src/packages/StorageFileApi.ts", "6": "src/packages/StorageVectorsClient.ts", "7": "src/packages/StreamDownloadBuilder.ts", "8": "src/packages/VectorBucketApi.ts", "9": "src/packages/VectorDataApi.ts", "10": "src/packages/VectorIndexApi.ts", "11": "../../../CONTRIBUTING.md" }, "reflections": { "1": 1, "2": 2, "3": 46, "4": 135, "5": 260, "6": 530, "7": 735, "8": 761, "9": 825, "10": 890 } } }