mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
supabase-supabase-autofixer[bot]andsupabase-releaser[bot]
af24c397fd
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.
**Details:**
- **Version:** `2.107.0`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files
🤖 Auto-generated from @supabase/supabase-js stable release.
Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
35694 lines
1.4 MiB
Plaintext
35694 lines
1.4 MiB
Plaintext
{
|
|
"id": 0,
|
|
"name": "@supabase/storage-js",
|
|
"variant": "project",
|
|
"kind": 1,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1,
|
|
"name": "index",
|
|
"variant": "declaration",
|
|
"kind": 2,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1456,
|
|
"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": 1457,
|
|
"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": 149,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L149"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "InternalError"
|
|
}
|
|
},
|
|
{
|
|
"id": 1460,
|
|
"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": 155,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L155"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "S3VectorBucketNotEmpty"
|
|
}
|
|
},
|
|
{
|
|
"id": 1458,
|
|
"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": 151,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L151"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "S3VectorConflictException"
|
|
}
|
|
},
|
|
{
|
|
"id": 1461,
|
|
"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": 157,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L157"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "S3VectorMaxBucketsExceeded"
|
|
}
|
|
},
|
|
{
|
|
"id": 1462,
|
|
"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": 159,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L159"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "S3VectorMaxIndexesExceeded"
|
|
}
|
|
},
|
|
{
|
|
"id": 1459,
|
|
"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": 153,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L153"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "S3VectorNotFoundException"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Enumeration Members",
|
|
"children": [1457, 1460, 1458, 1461, 1462, 1459]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 147,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L147"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1371,
|
|
"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": 1372,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 62,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L62"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1373,
|
|
"name": "StorageApiError",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 62,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L62"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1374,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1375,
|
|
"name": "status",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1376,
|
|
"name": "statusCode",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1377,
|
|
"name": "namespace",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1352,
|
|
"name": "ErrorNamespace",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"defaultValue": "'storage'"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1371,
|
|
"name": "StorageApiError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1355,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1354,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1378,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 59,
|
|
"character": 11,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L59"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1362,
|
|
"name": "StorageError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1379,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 60,
|
|
"character": 11,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L60"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1363,
|
|
"name": "StorageError.statusCode"
|
|
}
|
|
},
|
|
{
|
|
"id": 1380,
|
|
"name": "toJSON",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 74,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1381,
|
|
"name": "toJSON",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 74,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1382,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1384,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 76,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L76"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1383,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 75,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L75"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1385,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 77,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L77"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1386,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 78,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L78"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1384, 1383, 1385, 1386]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 74,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1365,
|
|
"name": "StorageError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1364,
|
|
"name": "StorageError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [1372]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [1378, 1379]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [1380]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 58,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L58"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1422,
|
|
"name": "StorageVectorsApiError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 984,
|
|
"name": "StorageClient",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 985,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 36,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L36"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 986,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Using supabase-js (recommended)",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst avatars = supabase.storage.from('avatars')\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Standalone import for bundle-sensitive environments",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {\n apikey: 'your-publishable-key',\n})\nconst avatars = storage.from('avatars')\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 36,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L36"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 987,
|
|
"name": "url",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 988,
|
|
"name": "headers",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 989,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 38,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L38"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 990,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 38,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L38"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 991,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 992,
|
|
"name": "fetch",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 993,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 994,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 995,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 996,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 997,
|
|
"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/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 998,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 999,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1000,
|
|
"name": "opts",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1112,
|
|
"name": "StorageClientOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 984,
|
|
"name": "StorageClient",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 138,
|
|
"name": "default.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 137,
|
|
"name": "default.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1006,
|
|
"name": "analytics",
|
|
"variant": "declaration",
|
|
"kind": 262144,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 95,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L95"
|
|
}
|
|
],
|
|
"getSignature": {
|
|
"id": 1007,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 95,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L95"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 48,
|
|
"name": "StorageAnalyticsClient",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1004,
|
|
"name": "vectors",
|
|
"variant": "declaration",
|
|
"kind": 262144,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 75,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L75"
|
|
}
|
|
],
|
|
"getSignature": {
|
|
"id": 1005,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 75,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L75"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 549,
|
|
"name": "StorageVectorsClient",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1026,
|
|
"name": "createBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 188,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1027,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 188,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1028,
|
|
"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": 1029,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1030,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1033,
|
|
"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": 193,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L193"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1032,
|
|
"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": 192,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L192"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1031,
|
|
"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": 191,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L191"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1034,
|
|
"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": 194,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L194"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1123,
|
|
"name": "BucketType",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1033, 1032, 1031, 1034]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 190,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L190"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1035,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1036,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 200,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L200"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Pick"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1125,
|
|
"name": "Bucket",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "name"
|
|
}
|
|
],
|
|
"name": "Pick",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 1037,
|
|
"name": "error",
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1036, 1037]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 199,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L199"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1038,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1039,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 204,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L204"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1040,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 205,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L205"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1039, 1040]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 203,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L203"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 172,
|
|
"name": "default.createBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 171,
|
|
"name": "default.createBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 1068,
|
|
"name": "deleteBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 378,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1069,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 378,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1070,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1071,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1072,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 380,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1073,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1074,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 380,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1074]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 380,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1075,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 381,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L381"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1072, 1075]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 379,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L379"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1076,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1077,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 384,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L384"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1078,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 385,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L385"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1077, 1078]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 383,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L383"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 214,
|
|
"name": "default.deleteBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 213,
|
|
"name": "default.deleteBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 1057,
|
|
"name": "emptyBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 331,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1058,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 331,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1059,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1060,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1061,
|
|
"name": "data",
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1062,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1063,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 333,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1063]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 333,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1064,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 334,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L334"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1061, 1064]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 332,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L332"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1065,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1066,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 337,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L337"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1067,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 338,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L338"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1066, 1067]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 336,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L336"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 203,
|
|
"name": "default.emptyBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 202,
|
|
"name": "default.emptyBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 1001,
|
|
"name": "from",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 58,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L58"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1002,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 58,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L58"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1003,
|
|
"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": 1017,
|
|
"name": "getBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 129,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1018,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 129,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1019,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1020,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1021,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 131,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L131"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1125,
|
|
"name": "Bucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1022,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 132,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L132"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1021, 1022]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 130,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L130"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1023,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1024,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 135,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L135"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1025,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 136,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L136"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1024, 1025]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 134,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L134"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 163,
|
|
"name": "default.getBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 162,
|
|
"name": "default.getBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 1008,
|
|
"name": "listBuckets",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 71,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1009,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 71,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1010,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Query parameters for listing buckets"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1135,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1011,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1012,
|
|
"name": "data",
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L73"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1125,
|
|
"name": "Bucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1013,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 74,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L74"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1012, 1013]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 72,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L72"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 77,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L77"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1016,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 78,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1015, 1016]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 76,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L76"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 154,
|
|
"name": "default.listBuckets"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 153,
|
|
"name": "default.listBuckets"
|
|
}
|
|
},
|
|
{
|
|
"id": 1096,
|
|
"name": "setHeader",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1097,
|
|
"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": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1098,
|
|
"name": "name",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Header name"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1099,
|
|
"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": 1094,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1095,
|
|
"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": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 243,
|
|
"name": "default.throwOnError"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 242,
|
|
"name": "default.throwOnError"
|
|
}
|
|
},
|
|
{
|
|
"id": 1041,
|
|
"name": "updateBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 267,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1042,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 267,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1043,
|
|
"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": 1044,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1045,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1048,
|
|
"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": 272,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1047,
|
|
"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": 271,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L271"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1046,
|
|
"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": 270,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L270"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1048, 1047, 1046]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 269,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L269"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1049,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1050,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1051,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1052,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 276,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1052]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 276,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1053,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L277"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1050, 1053]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 275,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L275"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1054,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1055,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 280,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L280"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1056,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 281,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L281"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1055, 1056]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 279,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L279"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 187,
|
|
"name": "default.updateBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"name": "default.updateBucket"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [985]
|
|
},
|
|
{
|
|
"title": "Accessors",
|
|
"children": [1006, 1004]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [1026, 1068, 1057, 1001, 1017, 1008, 1096, 1094, 1041]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Other",
|
|
"children": [1096, 1094]
|
|
},
|
|
{
|
|
"title": "Storage",
|
|
"children": [985, 1006, 1004, 1026, 1068, 1057, 1001, 1017, 1008, 1041]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 11,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L11"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 136,
|
|
"name": "default",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1353,
|
|
"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": 1354,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L17"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1355,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L17"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1356,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1357,
|
|
"name": "namespace",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1352,
|
|
"name": "ErrorNamespace",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"defaultValue": "'storage'"
|
|
},
|
|
{
|
|
"id": 1358,
|
|
"name": "status",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1359,
|
|
"name": "statusCode",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Error.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Error.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1362,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L14"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1363,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L15"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1364,
|
|
"name": "toJSON",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1365,
|
|
"name": "toJSON",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1366,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1368,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 32,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1367,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 31,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1369,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 33,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1370,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 34,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1368, 1367, 1369, 1370]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [1354]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [1362, 1363]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [1364]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 11,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L11"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Error"
|
|
},
|
|
"name": "Error",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1371,
|
|
"name": "StorageApiError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 1389,
|
|
"name": "StorageUnknownError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 1407,
|
|
"name": "StorageVectorsError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1389,
|
|
"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": 1390,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L93"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1391,
|
|
"name": "StorageUnknownError",
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L93"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1392,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1393,
|
|
"name": "originalError",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 1394,
|
|
"name": "namespace",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1352,
|
|
"name": "ErrorNamespace",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"defaultValue": "'storage'"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1389,
|
|
"name": "StorageUnknownError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1355,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1354,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1395,
|
|
"name": "originalError",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 91,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L91"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 1398,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1362,
|
|
"name": "StorageError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1399,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1363,
|
|
"name": "StorageError.statusCode"
|
|
}
|
|
},
|
|
{
|
|
"id": 1400,
|
|
"name": "toJSON",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1401,
|
|
"name": "toJSON",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1402,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1404,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 32,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1403,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 31,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1405,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 33,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1406,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 34,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1404, 1403, 1405, 1406]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 1365,
|
|
"name": "StorageError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 1364,
|
|
"name": "StorageError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [1390]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [1395, 1398, 1399]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [1400]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 90,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L90"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1439,
|
|
"name": "StorageVectorsUnknownError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1422,
|
|
"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": 1423,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 128,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L128"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1424,
|
|
"name": "StorageVectorsApiError",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 128,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L128"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1425,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1426,
|
|
"name": "status",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1427,
|
|
"name": "statusCode",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1422,
|
|
"name": "StorageVectorsApiError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1373,
|
|
"name": "StorageApiError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1372,
|
|
"name": "StorageApiError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1428,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 59,
|
|
"character": 11,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L59"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 1378,
|
|
"name": "StorageApiError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1429,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 60,
|
|
"character": 11,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L60"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 1379,
|
|
"name": "StorageApiError.statusCode"
|
|
}
|
|
},
|
|
{
|
|
"id": 1430,
|
|
"name": "toJSON",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 74,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1431,
|
|
"name": "toJSON",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 74,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1432,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1434,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 76,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L76"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1433,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 75,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L75"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1435,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 77,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L77"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1436,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 78,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L78"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1434, 1433, 1435, 1436]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 74,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L74"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 1381,
|
|
"name": "StorageApiError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 1380,
|
|
"name": "StorageApiError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [1423]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [1428, 1429]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [1430]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 127,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L127"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1371,
|
|
"name": "StorageApiError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1407,
|
|
"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": 1408,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 109,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L109"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1409,
|
|
"name": "StorageVectorsError",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 109,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L109"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1410,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1407,
|
|
"name": "StorageVectorsError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1355,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1354,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1413,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1362,
|
|
"name": "StorageError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1414,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1363,
|
|
"name": "StorageError.statusCode"
|
|
}
|
|
},
|
|
{
|
|
"id": 1415,
|
|
"name": "toJSON",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1416,
|
|
"name": "toJSON",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1417,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1419,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 32,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1418,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 31,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1420,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 33,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1421,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 34,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1419, 1418, 1420, 1421]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 1365,
|
|
"name": "StorageError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 1364,
|
|
"name": "StorageError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [1408]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [1413, 1414]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [1415]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 108,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L108"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1439,
|
|
"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": 1440,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 138,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L138"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1441,
|
|
"name": "StorageVectorsUnknownError",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 138,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L138"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1442,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1443,
|
|
"name": "originalError",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1439,
|
|
"name": "StorageVectorsUnknownError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1391,
|
|
"name": "StorageUnknownError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1390,
|
|
"name": "StorageUnknownError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1444,
|
|
"name": "originalError",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 91,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L91"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 1395,
|
|
"name": "StorageUnknownError.originalError"
|
|
}
|
|
},
|
|
{
|
|
"id": 1447,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1398,
|
|
"name": "StorageUnknownError.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 1448,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1399,
|
|
"name": "StorageUnknownError.statusCode"
|
|
}
|
|
},
|
|
{
|
|
"id": 1449,
|
|
"name": "toJSON",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1450,
|
|
"name": "toJSON",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1451,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1453,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 32,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L32"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1452,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 31,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L31"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1454,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 33,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L33"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1455,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 34,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L34"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1453, 1452, 1454, 1455]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 30,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L30"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 1401,
|
|
"name": "StorageUnknownError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 1400,
|
|
"name": "StorageUnknownError.toJSON"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [1440]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [1444, 1447, 1448]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [1449]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 137,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L137"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1389,
|
|
"name": "StorageUnknownError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1141,
|
|
"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": 1145,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L42"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1144,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L40"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1142,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L36"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1143,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L38"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "ANALYTICS"
|
|
}
|
|
},
|
|
{
|
|
"id": 1146,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L44"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1145, 1144, 1142, 1143, 1146]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 34,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L34"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1125,
|
|
"name": "Bucket",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1131,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L16"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1132,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L17"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1130,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L15"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1126,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L11"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1128,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L13"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1129,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L14"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1134,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L19"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1127,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L12"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1123,
|
|
"name": "BucketType",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1133,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L18"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1131, 1132, 1130, 1126, 1128, 1129, 1134, 1127, 1133]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 10,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L10"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1307,
|
|
"name": "DeleteVectorsOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for batch deleting vectors"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1309,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L549"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1310,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L550"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1308,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L548"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1309, 1310, 1308]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 547,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L547"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1190,
|
|
"name": "DestinationOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1191,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L176"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1191]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 175,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L175"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1243,
|
|
"name": "EncryptionConfiguration",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Configuration for encryption at rest"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1244,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L362"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1245,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L363"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1244, 1245]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 361,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L361"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1341,
|
|
"name": "ErrorResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Standard response wrapper for failed operations"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1342,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L646"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1343,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L647"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1342, 1343]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 645,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L645"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1222,
|
|
"name": "FetchParameters",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1224,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1223,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L285"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "AbortSignal"
|
|
},
|
|
"name": "AbortSignal",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1224, 1223]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 281,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L281"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1147,
|
|
"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": 1151,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L59"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1153,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L63"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1148,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L53"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1154,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L65"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1152,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L61"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1150,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L57"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1149,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L55"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1151, 1153, 1148, 1154, 1152, 1150, 1149]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 51,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L51"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 1155,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L67"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1156,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1157,
|
|
"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": 1164,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L94"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1166,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L104"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1125,
|
|
"name": "Bucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1161,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L85"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1159,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L81"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1162,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L87"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1163,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L89"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"name": "FileMetadata",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1158,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L79"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1165,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L99"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1160,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": [1164, 1166, 1161, 1159, 1162, 1163, 1158, 1165, 1160]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 77,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L77"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1167,
|
|
"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": 1171,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L119"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1174,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L125"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1175,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L127"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1172,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L121"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1176,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L129"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1168,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L113"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1177,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L131"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1178,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L133"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"name": "FileMetadata",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1170,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L117"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1173,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L123"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1179,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L138"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1169,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L115"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1171, 1174, 1175, 1172, 1176, 1168, 1177, 1178, 1170, 1173, 1179, 1169]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 111,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L111"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1183,
|
|
"name": "FileOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1184,
|
|
"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=<seconds>`"
|
|
},
|
|
{
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L150"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1185,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L154"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1187,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L162"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1189,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L172"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Record"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 1188,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L167"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Record"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 1186,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L158"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1184, 1185, 1187, 1189, 1188, 1186]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 146,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L146"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1295,
|
|
"name": "GetVectorsOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for batch reading vectors"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1297,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L515"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1298,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L516"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1299,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L517"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1300,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L518"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1296,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L514"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1297, 1298, 1299, 1300, 1296]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 513,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L513"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1301,
|
|
"name": "GetVectorsResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Response from getting vectors"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1302,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L526"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1271,
|
|
"name": "VectorMatch",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1302]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 525,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L525"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1135,
|
|
"name": "ListBucketOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1136,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L23"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1137,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L24"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1140,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L27"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1138,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1139,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": [1136, 1137, 1140, 1138, 1139]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 22,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L22"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1285,
|
|
"name": "ListIndexesOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for listing indexes within a bucket"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1288,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L491"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1289,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L492"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1287,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L490"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1286,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L489"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1288, 1289, 1287, 1286]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 488,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L488"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1290,
|
|
"name": "ListIndexesResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Response from listing indexes"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1291,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1292,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1293,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1293]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 501,
|
|
"character": 11,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L501"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1294,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L502"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1291, 1294]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 500,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L500"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1276,
|
|
"name": "ListVectorBucketsOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for fetching vector buckets"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1278,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L467"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1279,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L468"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1277,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L466"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1278, 1279, 1277]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 465,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L465"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1280,
|
|
"name": "ListVectorBucketsResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Response from listing vector buckets"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1284,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L478"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1281,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1282,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1283,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1283]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 477,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L477"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1284, 1281]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 476,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L476"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1311,
|
|
"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": 1313,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L567"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1314,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L568"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1315,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L569"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1316,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L570"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1317,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L571"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1318,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L572"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1319,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L573"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1312,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L566"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1313, 1314, 1315, 1316, 1317, 1318, 1319, 1312]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 565,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L565"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1320,
|
|
"name": "ListVectorsResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Response from listing vectors"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1322,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L583"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1321,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L582"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1271,
|
|
"name": "VectorMatch",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1322, 1321]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 581,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L581"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1225,
|
|
"name": "Metadata",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1226,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L301"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1226]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 300,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L300"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1250,
|
|
"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": 1251,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L384"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1251]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 383,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L383"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1303,
|
|
"name": "PutVectorsOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for batch inserting/updating vectors"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1305,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L537"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1304,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L536"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1306,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L538"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1267,
|
|
"name": "VectorObject",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1305, 1304, 1306]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 535,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L535"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1324,
|
|
"name": "QueryVectorsOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for querying similar vectors (ANN search)"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1329,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L607"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1323,
|
|
"name": "VectorFilter",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1326,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L604"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1327,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L605"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1264,
|
|
"name": "VectorData",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1330,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L608"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1331,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L609"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1328,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L606"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1325,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L603"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1329, 1326, 1327, 1330, 1331, 1328, 1325]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 602,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L602"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1332,
|
|
"name": "QueryVectorsResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Response from vector similarity query"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1334,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L619"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1254,
|
|
"name": "DistanceMetric",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1333,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L618"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1271,
|
|
"name": "VectorMatch",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1334, 1333]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 617,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L617"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1192,
|
|
"name": "SearchOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1193,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L184"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1194,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L189"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1196,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L199"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1195,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L194"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1180,
|
|
"name": "SortBy",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1193, 1194, 1196, 1195]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 179,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L179"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1214,
|
|
"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": 1216,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L271"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1215,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L269"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1216, 1215]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 267,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L267"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1206,
|
|
"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": 1211,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L257"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1209,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L253"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1208,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L251"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1213,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L261"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1212,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L259"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"name": "FileMetadata",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1207,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L249"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1210,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L255"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1211, 1209, 1208, 1213, 1212, 1207, 1210]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 247,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L247"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1200,
|
|
"name": "SearchV2Options",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1203,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L222"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1201,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L212"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1202,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L217"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1205,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L239"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1197,
|
|
"name": "SortByV2",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1204,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L233"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1203, 1201, 1202, 1205, 1204]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 207,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L207"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1217,
|
|
"name": "SearchV2Result",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1219,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L276"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1214,
|
|
"name": "SearchV2Folder",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1218,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L275"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1221,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L278"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1220,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L277"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1206,
|
|
"name": "SearchV2Object",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1219, 1218, 1221, 1220]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 274,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L274"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1180,
|
|
"name": "SortBy",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1181,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L142"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1182,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L143"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1181, 1182]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 141,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L141"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1197,
|
|
"name": "SortByV2",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1198,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1199,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": [1198, 1199]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 202,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L202"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1112,
|
|
"name": "StorageClientOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1113,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L8"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1113]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 7,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/StorageClient.ts#L7"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1337,
|
|
"name": "SuccessResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Standard response wrapper for successful operations"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1338,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L636"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1340,
|
|
"name": "T",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "SuccessResponse.T",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 1339,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L637"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1338, 1339]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 635,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L635"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 1340,
|
|
"name": "T",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1227,
|
|
"name": "TransformOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1232,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L332"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "origin"
|
|
}
|
|
},
|
|
{
|
|
"id": 1229,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L312"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1231,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L325"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1230,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1228,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L308"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1232, 1229, 1231, 1230, 1228]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 304,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L304"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1246,
|
|
"name": "VectorBucket",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector bucket metadata"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1248,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L374"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1249,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L375"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1243,
|
|
"name": "EncryptionConfiguration",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1247,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L373"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1248, 1249, 1247]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 372,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L372"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1264,
|
|
"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": 1265,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L424"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1265]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 423,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L423"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1335,
|
|
"name": "VectorFetchParameters",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Fetch-specific parameters like abort signals"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1336,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L627"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "AbortSignal"
|
|
},
|
|
"name": "AbortSignal",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1336]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 626,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L626"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1256,
|
|
"name": "VectorIndex",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector index configuration and metadata"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1263,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L415"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1259,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L411"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1252,
|
|
"name": "VectorDataType",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1260,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L412"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1261,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L413"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1254,
|
|
"name": "DistanceMetric",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1257,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L409"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1262,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L414"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1250,
|
|
"name": "MetadataConfiguration",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1258,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L410"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1263, 1259, 1260, 1261, 1257, 1262, 1258]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 408,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L408"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1271,
|
|
"name": "VectorMatch",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector object returned from queries with optional distance"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1273,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L454"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1264,
|
|
"name": "VectorData",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1275,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L456"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1272,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L453"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1274,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L455"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1266,
|
|
"name": "VectorMetadata",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1273, 1275, 1272, 1274]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 452,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L452"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1267,
|
|
"name": "VectorObject",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Single vector object for insertion/update"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1269,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L441"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1264,
|
|
"name": "VectorData",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1268,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L440"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1270,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L442"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1266,
|
|
"name": "VectorMetadata",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1269, 1268, 1270]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 439,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L439"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1344,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L654"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 1345,
|
|
"name": "T",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1337,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1345,
|
|
"name": "T",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "SuccessResponse",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 1341,
|
|
"name": "ErrorResponse",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1123,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L8"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "STANDARD"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "ANALYTICS"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1124,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 8,
|
|
"character": 62,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L8"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1233,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L339"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 1234,
|
|
"name": "T",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "mapped",
|
|
"parameter": "K",
|
|
"parameterType": {
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"target": 1234,
|
|
"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": 1234,
|
|
"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/.pnpm/typescript@5.8.3/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": 1254,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1255,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 396,
|
|
"character": 79,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L396"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1235,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L343"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 1242,
|
|
"name": "T",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1236,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1237,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L345"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1242,
|
|
"name": "T",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 1238,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L346"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1237, 1238]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 344,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L344"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1239,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1240,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L349"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1241,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L350"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1240, 1241]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 348,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L348"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1352,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L5"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "storage"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "vectors"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1252,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L391"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "float32"
|
|
},
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1253,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 391,
|
|
"character": 51,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L391"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1323,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L590"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Record"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 1266,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/types.ts#L431"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Record"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 1346,
|
|
"name": "isStorageError",
|
|
"variant": "declaration",
|
|
"kind": 64,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 50,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L50"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1347,
|
|
"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": 50,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L50"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1348,
|
|
"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": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1349,
|
|
"name": "isStorageVectorsError",
|
|
"variant": "declaration",
|
|
"kind": 64,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/errors.ts",
|
|
"line": 119,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L119"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1350,
|
|
"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": 119,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/errors.ts#L119"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1351,
|
|
"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": 1407,
|
|
"name": "StorageVectorsError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1122,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L15"
|
|
}
|
|
],
|
|
"target": 912
|
|
},
|
|
{
|
|
"id": 1114,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L3"
|
|
}
|
|
],
|
|
"target": 48
|
|
},
|
|
{
|
|
"id": 1115,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L7"
|
|
}
|
|
],
|
|
"target": 549
|
|
},
|
|
{
|
|
"id": 1118,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L11"
|
|
}
|
|
],
|
|
"target": 536
|
|
},
|
|
{
|
|
"id": 1116,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L8"
|
|
}
|
|
],
|
|
"target": 604
|
|
},
|
|
{
|
|
"id": 1117,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/index.ts#L9"
|
|
}
|
|
],
|
|
"target": 672
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Enumerations",
|
|
"children": [1456]
|
|
},
|
|
{
|
|
"title": "Classes",
|
|
"children": [1371, 984, 1353, 1389, 1422, 1407, 1439]
|
|
},
|
|
{
|
|
"title": "Interfaces",
|
|
"children": [
|
|
1141, 1125, 1307, 1190, 1243, 1341, 1222, 1147, 1157, 1167, 1183, 1295, 1301, 1135,
|
|
1285, 1290, 1276, 1280, 1311, 1320, 1225, 1250, 1303, 1324, 1332, 1192, 1214, 1206,
|
|
1200, 1217, 1180, 1197, 1112, 1337, 1227, 1246, 1264, 1335, 1256, 1271, 1267
|
|
]
|
|
},
|
|
{
|
|
"title": "Type Aliases",
|
|
"children": [1344, 1123, 1233, 1254, 1235, 1352, 1252, 1323, 1266]
|
|
},
|
|
{
|
|
"title": "Functions",
|
|
"children": [1346, 1349]
|
|
},
|
|
{
|
|
"title": "References",
|
|
"children": [1122, 1114, 1115, 1118, 1116, 1117]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/index.ts",
|
|
"line": 1,
|
|
"character": 0,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L10"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L14"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 741,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1235,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1235,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L18"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 19,
|
|
"name": "TResult1",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"target": 1235,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L19"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 24,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1235,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L5"
|
|
}
|
|
],
|
|
"implementedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1235,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 50,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Analytics Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Using supabase-js (recommended)",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.storage.analytics.listBuckets()\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Standalone import for bundle-sensitive environments",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```typescript\nimport { StorageAnalyticsClient } from '@supabase/storage-js'\n\nconst client = new StorageAnalyticsClient(url, headers)\n```"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 50,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50"
|
|
}
|
|
],
|
|
"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": 50,
|
|
"character": 36,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 54,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 50,
|
|
"character": 38,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L50"
|
|
}
|
|
],
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/.pnpm/@types+node@20.19.9/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/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/.pnpm/@types+node@20.19.9/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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<StorageError>.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "BaseApiClient<StorageError>.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 64,
|
|
"name": "createBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 95,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L95"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 95,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L95"
|
|
}
|
|
],
|
|
"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/.pnpm/typescript@5.8.3/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": 97,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L97"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1141,
|
|
"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": 98,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L98"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [68, 69]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 96,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L96"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 101,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L101"
|
|
}
|
|
],
|
|
"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": 102,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L102"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [71, 72]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 100,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L100"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 88,
|
|
"name": "deleteBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 228,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L228"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 228,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L228"
|
|
}
|
|
],
|
|
"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/.pnpm/typescript@5.8.3/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": 230,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230"
|
|
}
|
|
],
|
|
"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": 230,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [94]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 230,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L230"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 95,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 231,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L231"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [92, 95]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 229,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L229"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 234,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L234"
|
|
}
|
|
],
|
|
"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": 235,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L235"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [97, 98]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 233,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L233"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 99,
|
|
"name": "from",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 372,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L372"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 372,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L372"
|
|
}
|
|
],
|
|
"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": 161,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 161,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161"
|
|
}
|
|
],
|
|
"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": 162,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L162"
|
|
}
|
|
],
|
|
"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": 163,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L163"
|
|
}
|
|
],
|
|
"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": 166,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L166"
|
|
}
|
|
],
|
|
"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": 164,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L164"
|
|
}
|
|
],
|
|
"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": 165,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L165"
|
|
}
|
|
],
|
|
"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": 161,
|
|
"character": 30,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L161"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 169,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L169"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1141,
|
|
"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": 170,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L170"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [83, 84]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 168,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L168"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 173,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L173"
|
|
}
|
|
],
|
|
"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": 174,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L174"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [86, 87]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 172,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L172"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"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": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"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": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"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": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"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": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"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": "Other",
|
|
"children": [119, 117]
|
|
},
|
|
{
|
|
"title": "Storage",
|
|
"children": [49, 64, 88, 99, 73]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 21,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1353,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/.pnpm/iceberg-js@0.8.1/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/.pnpm/iceberg-js@0.8.1/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/.pnpm/@types+node@20.19.9/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/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/.pnpm/@types+node@20.19.9/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 1112,
|
|
"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<StorageError>.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "BaseApiClient<StorageError>.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 171,
|
|
"name": "createBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 188,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 188,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L188"
|
|
}
|
|
],
|
|
"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": 193,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L193"
|
|
}
|
|
],
|
|
"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": 192,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L192"
|
|
}
|
|
],
|
|
"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": 191,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L191"
|
|
}
|
|
],
|
|
"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": 194,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L194"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1123,
|
|
"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": 190,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L190"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 200,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L200"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Pick"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1125,
|
|
"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": 201,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [181, 182]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 199,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L199"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 204,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L204"
|
|
}
|
|
],
|
|
"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": 205,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L205"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [184, 185]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 203,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L203"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 213,
|
|
"name": "deleteBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 378,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 378,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L378"
|
|
}
|
|
],
|
|
"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/.pnpm/typescript@5.8.3/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": 380,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380"
|
|
}
|
|
],
|
|
"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": 380,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [219]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 380,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L380"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 220,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 381,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L381"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [217, 220]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 379,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L379"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 384,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L384"
|
|
}
|
|
],
|
|
"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": 385,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L385"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [222, 223]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 383,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L383"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 202,
|
|
"name": "emptyBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 331,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 331,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L331"
|
|
}
|
|
],
|
|
"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/.pnpm/typescript@5.8.3/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": 333,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333"
|
|
}
|
|
],
|
|
"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": 333,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [208]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 333,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L333"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 209,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 334,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L334"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [206, 209]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 332,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L332"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 337,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L337"
|
|
}
|
|
],
|
|
"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": 338,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L338"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [211, 212]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 336,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L336"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 162,
|
|
"name": "getBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 129,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 129,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L129"
|
|
}
|
|
],
|
|
"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/.pnpm/typescript@5.8.3/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": 131,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L131"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1125,
|
|
"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": 132,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L132"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [166, 167]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 130,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L130"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 135,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L135"
|
|
}
|
|
],
|
|
"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": 136,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L136"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [169, 170]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 134,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L134"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 153,
|
|
"name": "listBuckets",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 71,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 71,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L71"
|
|
}
|
|
],
|
|
"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": 1135,
|
|
"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/.pnpm/typescript@5.8.3/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": 73,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L73"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1125,
|
|
"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": 74,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L74"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [157, 158]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 72,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L72"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 77,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L77"
|
|
}
|
|
],
|
|
"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": 78,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [160, 161]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 76,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L76"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"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": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"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": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"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": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"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": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"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": 267,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 267,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L267"
|
|
}
|
|
],
|
|
"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": 272,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L272"
|
|
}
|
|
],
|
|
"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": 271,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L271"
|
|
}
|
|
],
|
|
"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": 270,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L270"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [193, 192, 191]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 269,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L269"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 276,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276"
|
|
}
|
|
],
|
|
"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": 276,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [197]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 276,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L276"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 198,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L277"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [195, 198]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 275,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L275"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 280,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L280"
|
|
}
|
|
],
|
|
"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": 281,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L281"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [200, 201]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 279,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageBucketApi.ts#L279"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [137]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [171, 213, 202, 162, 153, 244, 242, 186]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Other",
|
|
"children": [137, 244, 242]
|
|
},
|
|
{
|
|
"title": "Storage",
|
|
"children": [171, 213, 202, 162, 153, 186]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 8,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
],
|
|
"name": "default",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"target": 984,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 55,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L55"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 263,
|
|
"name": "default",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 55,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L55"
|
|
}
|
|
],
|
|
"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": 57,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L57"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 267,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 57,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L57"
|
|
}
|
|
],
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/.pnpm/@types+node@20.19.9/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/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/.pnpm/@types+node@20.19.9/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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<StorageError>.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "BaseApiClient<StorageError>.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 369,
|
|
"name": "copy",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 600,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L600"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 600,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L600"
|
|
}
|
|
],
|
|
"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": 1190,
|
|
"name": "DestinationOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 606,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606"
|
|
}
|
|
],
|
|
"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": 606,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [377]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 606,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L606"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 378,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 607,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L607"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [375, 378]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 605,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L605"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 610,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L610"
|
|
}
|
|
],
|
|
"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": 611,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L611"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [380, 381]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 609,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L609"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 325,
|
|
"name": "createSignedUploadUrl",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 380,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L380"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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=<TOKEN>\",\n \"path\": \"folder/cat.jpg\",\n \"token\": \"<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": 380,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L380"
|
|
}
|
|
],
|
|
"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": 382,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L382"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [330]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 382,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L382"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 385,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385"
|
|
}
|
|
],
|
|
"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": 385,
|
|
"character": 50,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385"
|
|
}
|
|
],
|
|
"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": 385,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385"
|
|
}
|
|
],
|
|
"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": 385,
|
|
"character": 35,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [336, 334, 335]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 385,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L385"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 337,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 386,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L386"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [332, 337]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 384,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L384"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 389,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L389"
|
|
}
|
|
],
|
|
"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": 390,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L390"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [339, 340]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 388,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L388"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 382,
|
|
"name": "createSignedUrl",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 689,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L689"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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=<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": 689,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L689"
|
|
}
|
|
],
|
|
"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": 390,
|
|
"name": "cacheNonce",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Append a cache nonce parameter to the URL to invalidate the cache."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 695,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L695"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"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": 693,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L693"
|
|
}
|
|
],
|
|
"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": 694,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L694"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1227,
|
|
"name": "TransformOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [390, 388, 389]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 692,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L692"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 391,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 392,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 699,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 393,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 394,
|
|
"name": "signedUrl",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 699,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [394]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 699,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L699"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 395,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 700,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L700"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [392, 395]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 698,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L698"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 396,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 397,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 703,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L703"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 398,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 704,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L704"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [397, 398]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 702,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L702"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 399,
|
|
"name": "createSignedUrls",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 784,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L784"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 400,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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=<TOKEN>\",\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=<TOKEN>\"\n },\n {\n \"error\": null,\n \"path\": \"folder/avatar2.png\",\n \"signedURL\": \"/object/sign/avatars/folder/avatar2.png?token=<TOKEN>\",\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar2.png?token=<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": 784,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L784"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 401,
|
|
"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": 402,
|
|
"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": 403,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 404,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 406,
|
|
"name": "cacheNonce",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Append a cache nonce parameter to the URL to invalidate the cache."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 787,
|
|
"character": 45,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 405,
|
|
"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": 787,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [406, 405]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 787,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L787"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 407,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 408,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 790,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 409,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 410,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 790,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 411,
|
|
"name": "path",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 790,
|
|
"character": 38,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 412,
|
|
"name": "signedUrl",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 790,
|
|
"character": 59,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [410, 411, 412]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 790,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L790"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 413,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 791,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L791"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [408, 413]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 789,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L789"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 414,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 415,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 794,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L794"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 416,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 795,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L795"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [415, 416]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 793,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L793"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 417,
|
|
"name": "download",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 889,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 418,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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\": <BLOB>,\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": 889,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 419,
|
|
"name": "Options",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 420,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 422,
|
|
"name": "cacheNonce",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 889,
|
|
"character": 59,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 421,
|
|
"name": "transform",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 889,
|
|
"character": 29,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1227,
|
|
"name": "TransformOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [422, 421]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 889,
|
|
"character": 27,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L889"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 423,
|
|
"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": 424,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 419,
|
|
"name": "Options",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 425,
|
|
"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": 1222,
|
|
"name": "FetchParameters",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 3,
|
|
"name": "BlobDownloadBuilder",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 435,
|
|
"name": "exists",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 980,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L980"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 436,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 980,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L980"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 437,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"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": 982,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L982"
|
|
}
|
|
],
|
|
"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": 983,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L983"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [439, 440]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 981,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L981"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 441,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 442,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 986,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L986"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 443,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 987,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L987"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [442, 443]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 985,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L985"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 444,
|
|
"name": "getPublicUrl",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1079,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1079"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 445,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 1079,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1079"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 446,
|
|
"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": 447,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 448,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 451,
|
|
"name": "cacheNonce",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Append a cache nonce parameter to the URL to invalidate the cache."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1084,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1084"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 449,
|
|
"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": 1082,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1082"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 450,
|
|
"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": 1083,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1083"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1227,
|
|
"name": "TransformOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [451, 449, 450]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1081,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1081"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 452,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 453,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1086,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 454,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 455,
|
|
"name": "publicUrl",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1086,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [455]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1086,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [453]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1086,
|
|
"character": 5,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1086"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 426,
|
|
"name": "info",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 943,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L943"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 427,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 943,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L943"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 428,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"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": 945,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L945"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1233,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1167,
|
|
"name": "FileObjectV2",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
],
|
|
"name": "Camelize",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 431,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 946,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L946"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [430, 431]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 944,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L944"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 432,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 433,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 949,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L949"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 434,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 950,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L950"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [433, 434]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 948,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L948"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 465,
|
|
"name": "list",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1308,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1308"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 466,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 1308,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1308"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 467,
|
|
"name": "path",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The folder path."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 468,
|
|
"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": 1192,
|
|
"name": "SearchOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 469,
|
|
"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": 1222,
|
|
"name": "FetchParameters",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 470,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 471,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1314,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1314"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1157,
|
|
"name": "FileObject",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 472,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1315,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1315"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [471, 472]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1313,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1313"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 473,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 474,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1318,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1318"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 475,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1319,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1319"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [474, 475]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1317,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1317"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 476,
|
|
"name": "listV2",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1381,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1381"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 477,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 1381,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1381"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 478,
|
|
"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": 1200,
|
|
"name": "SearchV2Options",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 479,
|
|
"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": 1222,
|
|
"name": "FetchParameters",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 480,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 481,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1386,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1386"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1217,
|
|
"name": "SearchV2Result",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 482,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1387,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1387"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [481, 482]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1385,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1385"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 483,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 484,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1390,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1390"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 485,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1391,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1391"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [484, 485]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1389,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1389"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 356,
|
|
"name": "move",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 537,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L537"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 537,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L537"
|
|
}
|
|
],
|
|
"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": 1190,
|
|
"name": "DestinationOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 543,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543"
|
|
}
|
|
],
|
|
"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": 543,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [364]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 543,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L543"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 365,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 544,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L544"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [362, 365]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 542,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L542"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 547,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L547"
|
|
}
|
|
],
|
|
"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": 548,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L548"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [367, 368]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 546,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L546"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 456,
|
|
"name": "remove",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1143,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1143"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 457,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 1143,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1143"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 458,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 459,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 460,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1145,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1145"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1157,
|
|
"name": "FileObject",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 461,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1146,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1146"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [460, 461]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1144,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1144"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 462,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 463,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1149,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1149"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 464,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1150,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1150"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [463, 464]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1148,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1148"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 519,
|
|
"name": "setHeader",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 520,
|
|
"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": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 521,
|
|
"name": "name",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Header name"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 522,
|
|
"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": 517,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 518,
|
|
"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": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "BaseApiClient.throwOnError"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "BaseApiClient.throwOnError"
|
|
}
|
|
},
|
|
{
|
|
"id": 489,
|
|
"name": "toBase64",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1410,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1410"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 490,
|
|
"name": "toBase64",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1410,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1410"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 491,
|
|
"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": 476,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L476"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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 })\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- "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`update()`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " always replaces the file at the given path regardless of the "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`upsert`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " option.\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": 476,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L476"
|
|
}
|
|
],
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "ArrayBuffer"
|
|
},
|
|
"name": "ArrayBuffer",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "ReadableStream"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Uint8Array"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Blob"
|
|
},
|
|
"name": "Blob",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "File"
|
|
},
|
|
"name": "File",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "FormData"
|
|
},
|
|
"name": "FormData",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URLSearchParams"
|
|
},
|
|
"name": "URLSearchParams",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "ArrayBufferView"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "ArrayBufferLike"
|
|
},
|
|
"name": "ArrayBufferLike",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "ArrayBufferView",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/buffer.buffer.d.ts",
|
|
"qualifiedName": "__global.Buffer"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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, and metadata.\n**Note:** The "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`upsert`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " option has no effect here. "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`update()`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " always replaces the\nfile at the given path, so the "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`x-upsert`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " header is not sent. To control upsert\nbehavior, use "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`upload()`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " instead."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1183,
|
|
"name": "FileOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 492,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492"
|
|
}
|
|
],
|
|
"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": 492,
|
|
"character": 42,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492"
|
|
}
|
|
],
|
|
"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": 492,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492"
|
|
}
|
|
],
|
|
"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": 492,
|
|
"character": 28,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [351, 349, 350]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 492,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L492"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 352,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 493,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L493"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [347, 352]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 491,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L491"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 496,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L496"
|
|
}
|
|
],
|
|
"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": 497,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L497"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [354, 355]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 495,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L495"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 295,
|
|
"name": "upload",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 219,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L219"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": "@example",
|
|
"name": "Handling errors",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', avatarFile)\n\nif (error) {\n // Log the full error so fields like `statusCode` and `error` (the\n // Storage error name, e.g. \"Duplicate\") aren't hidden behind `error.message`.\n console.error(error)\n return\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": 219,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L219"
|
|
}
|
|
],
|
|
"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": 1183,
|
|
"name": "FileOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 225,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225"
|
|
}
|
|
],
|
|
"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": 225,
|
|
"character": 42,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225"
|
|
}
|
|
],
|
|
"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": 225,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225"
|
|
}
|
|
],
|
|
"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": 225,
|
|
"character": 28,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [305, 303, 304]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 225,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L225"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 306,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 226,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L226"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [301, 306]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 224,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L224"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 229,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L229"
|
|
}
|
|
],
|
|
"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": 230,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L230"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [308, 309]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 228,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L228"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 310,
|
|
"name": "uploadToSignedUrl",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 274,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L274"
|
|
}
|
|
],
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 274,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L274"
|
|
}
|
|
],
|
|
"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": 1183,
|
|
"name": "FileOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 90,
|
|
"character": 42,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90"
|
|
}
|
|
],
|
|
"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": 90,
|
|
"character": 54,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [317, 318]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 90,
|
|
"character": 40,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 90,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90"
|
|
}
|
|
],
|
|
"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": 339,
|
|
"character": 32,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339"
|
|
}
|
|
],
|
|
"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": 339,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "cleanPath"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [323, 322]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 339,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L339"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 324,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 90,
|
|
"character": 24,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [320, 324]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 90,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L90"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [262]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [
|
|
369, 325, 382, 399, 417, 435, 444, 426, 465, 476, 356, 456, 519, 517, 489, 341, 295,
|
|
310
|
|
]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Other",
|
|
"children": [262, 519, 517, 489]
|
|
},
|
|
{
|
|
"title": "Storage",
|
|
"children": [
|
|
369, 325, 382, 399, 417, 435, 444, 426, 465, 476, 356, 456, 341, 295, 310
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 52,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L52"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1353,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageFileApi.ts#L1"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 535,
|
|
"name": "packages/StorageVectorsClient",
|
|
"variant": "declaration",
|
|
"kind": 2,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 549,
|
|
"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": 550,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 109,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L109"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 551,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Using supabase-js (recommended)",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```typescript\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Standalone import for bundle-sensitive environments",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```typescript\nimport { StorageVectorsClient } from '@supabase/storage-js'\n\nconst client = new StorageVectorsClient(url, options)\n```"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 109,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L109"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 552,
|
|
"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": 553,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 536,
|
|
"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": 549,
|
|
"name": "StorageVectorsClient",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorBucketApi.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorBucketApi.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 557,
|
|
"name": "createBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 158,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L158"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 558,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 158,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L158"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 559,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"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": 568,
|
|
"name": "deleteBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 242,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L242"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 569,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 242,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L242"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 570,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"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": 554,
|
|
"name": "from",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 132,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L132"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 555,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 132,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L132"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 556,
|
|
"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": 604,
|
|
"name": "VectorBucketScope",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 560,
|
|
"name": "getBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 185,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 561,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 185,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 562,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 563,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 564,
|
|
"name": "vectorBucket",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 185,
|
|
"character": 67,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1246,
|
|
"name": "VectorBucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [564]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 185,
|
|
"character": 65,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L185"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"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": 565,
|
|
"name": "listBuckets",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 214,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L214"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 566,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 214,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L214"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 567,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Optional filters (prefix, maxResults, nextToken)"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1276,
|
|
"name": "ListVectorBucketsOptions",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1280,
|
|
"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": 588,
|
|
"name": "setHeader",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 589,
|
|
"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": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 590,
|
|
"name": "name",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Header name"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 591,
|
|
"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": 586,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 587,
|
|
"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": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"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": [550]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [557, 568, 554, 560, 565, 588, 586]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Other",
|
|
"children": [588, 586]
|
|
},
|
|
{
|
|
"title": "Storage",
|
|
"children": [550, 557, 568, 554, 560, 565]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 80,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L80"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "default",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 604,
|
|
"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": 605,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 273,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L273"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 606,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 273,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L273"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 607,
|
|
"name": "url",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 608,
|
|
"name": "headers",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 609,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 275,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L275"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 610,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 275,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L275"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 611,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 612,
|
|
"name": "vectorBucketName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 613,
|
|
"name": "fetch",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 614,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 615,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 616,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 617,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 618,
|
|
"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/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 619,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 620,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 604,
|
|
"name": "VectorBucketScope",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorIndexApi.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorIndexApi.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 622,
|
|
"name": "createIndex",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 311,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L311"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 623,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 311,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L311"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 624,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 912,
|
|
"name": "CreateIndexOptions",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "vectorBucketName"
|
|
}
|
|
],
|
|
"name": "Omit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"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": 633,
|
|
"name": "deleteIndex",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 390,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L390"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 634,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 390,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L390"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 635,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"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": 628,
|
|
"name": "getIndex",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 366,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L366"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 629,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 366,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L366"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 630,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 631,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 632,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L58"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1256,
|
|
"name": "VectorIndex",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [632]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts",
|
|
"line": 58,
|
|
"character": 25,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/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": 636,
|
|
"name": "index",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 426,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L426"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 637,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 426,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L426"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 638,
|
|
"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": 672,
|
|
"name": "VectorIndexScope",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 625,
|
|
"name": "listIndexes",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 338,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L338"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 626,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 338,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L338"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 627,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1285,
|
|
"name": "ListIndexesOptions",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "vectorBucketName"
|
|
}
|
|
],
|
|
"name": "Omit",
|
|
"package": "typescript"
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1290,
|
|
"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": 656,
|
|
"name": "setHeader",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 657,
|
|
"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": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 658,
|
|
"name": "name",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Header name"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 659,
|
|
"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": 654,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 655,
|
|
"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": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"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": [605]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [622, 633, 628, 636, 625, 656, 654]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Other",
|
|
"children": [656, 654]
|
|
},
|
|
{
|
|
"title": "Storage",
|
|
"children": [605, 622, 633, 628, 636, 625]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 256,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L256"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "default",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 672,
|
|
"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": 673,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 465,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L465"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 674,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 465,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L465"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 675,
|
|
"name": "url",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 676,
|
|
"name": "headers",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 677,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 467,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L467"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 678,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 467,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L467"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 679,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 680,
|
|
"name": "vectorBucketName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 681,
|
|
"name": "indexName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 682,
|
|
"name": "fetch",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 683,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 684,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 685,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 686,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 687,
|
|
"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/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 688,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 689,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 672,
|
|
"name": "VectorIndexScope",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorDataApi.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorDataApi.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 704,
|
|
"name": "deleteVectors",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 635,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L635"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 705,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 635,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L635"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 706,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1307,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"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": 695,
|
|
"name": "getVectors",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 536,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L536"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 696,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 536,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L536"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 697,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1295,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1301,
|
|
"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": 698,
|
|
"name": "listVectors",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 567,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L567"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 699,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 567,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L567"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 700,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1311,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1320,
|
|
"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": 692,
|
|
"name": "putVectors",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 505,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L505"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 693,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 505,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L505"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 694,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1303,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"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": 701,
|
|
"name": "queryVectors",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 603,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L603"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 702,
|
|
"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": "Storage"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"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": 603,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L603"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 703,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1324,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1344,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1332,
|
|
"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": 724,
|
|
"name": "setHeader",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 725,
|
|
"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": 58,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L58"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 726,
|
|
"name": "name",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Header name"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 727,
|
|
"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": 722,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/common/BaseApiClient.ts",
|
|
"line": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 723,
|
|
"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": 45,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/lib/common/BaseApiClient.ts#L45"
|
|
}
|
|
],
|
|
"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": [673]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [704, 695, 698, 692, 701, 724, 722]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Other",
|
|
"children": [724, 722]
|
|
},
|
|
{
|
|
"title": "Storage",
|
|
"children": [673, 704, 695, 698, 692, 701]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 446,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L446"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "default",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 536,
|
|
"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": 541,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L35"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 542,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 543,
|
|
"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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 544,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 545,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 546,
|
|
"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/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 547,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 548,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 537,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 538,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 539,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L30"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 540,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [541, 537]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 26,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L26"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"children": [549, 604, 672]
|
|
},
|
|
{
|
|
"title": "Interfaces",
|
|
"children": [536]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageVectorsClient.ts",
|
|
"line": 1,
|
|
"character": 0,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StorageVectorsClient.ts#L1"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 740,
|
|
"name": "packages/StreamDownloadBuilder",
|
|
"variant": "declaration",
|
|
"kind": 2,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 741,
|
|
"name": "default",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 742,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 8,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L8"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 743,
|
|
"name": "default",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 8,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L8"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 744,
|
|
"name": "downloadFn",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 745,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 9,
|
|
"character": 24,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L9"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 746,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 9,
|
|
"character": 24,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L9"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 747,
|
|
"name": "shouldThrowOnError",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 741,
|
|
"name": "StreamDownloadBuilder",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 781,
|
|
"name": "[toStringTag]",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isReadonly": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 5,
|
|
"character": 11,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L5"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "'StreamDownloadBuilder'",
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Promise.[toStringTag]"
|
|
}
|
|
},
|
|
{
|
|
"id": 765,
|
|
"name": "catch",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 22,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L22"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 766,
|
|
"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/StreamDownloadBuilder.ts",
|
|
"line": 22,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L22"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 767,
|
|
"name": "TResult",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 768,
|
|
"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": 769,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 23,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L23"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 770,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 23,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L23"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 771,
|
|
"name": "reason",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 767,
|
|
"name": "TResult",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "PromiseLike"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 767,
|
|
"name": "TResult",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1235,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": "reference",
|
|
"target": 767,
|
|
"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": 772,
|
|
"name": "finally",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 28,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 773,
|
|
"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/StreamDownloadBuilder.ts",
|
|
"line": 28,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 774,
|
|
"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": 775,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 28,
|
|
"character": 23,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 776,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 28,
|
|
"character": 23,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L28"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1235,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Promise.finally"
|
|
}
|
|
}
|
|
],
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Promise.finally"
|
|
}
|
|
},
|
|
{
|
|
"id": 753,
|
|
"name": "then",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 13,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L13"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 754,
|
|
"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": 13,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L13"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 755,
|
|
"name": "TResult1",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"target": 1235,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 756,
|
|
"name": "TResult2",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 757,
|
|
"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": 758,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 15,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L15"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 759,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 15,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L15"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 760,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1235,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/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": 755,
|
|
"name": "TResult1",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "PromiseLike"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 755,
|
|
"name": "TResult1",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 761,
|
|
"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": 762,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 17,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L17"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 763,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 17,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L17"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 764,
|
|
"name": "reason",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 756,
|
|
"name": "TResult2",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "PromiseLike"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 756,
|
|
"name": "TResult2",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 755,
|
|
"name": "TResult1",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 756,
|
|
"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": [742]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [781]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [765, 772, 753]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 4,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L4"
|
|
}
|
|
],
|
|
"implementedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1235,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "ReadableStream"
|
|
},
|
|
"name": "ReadableStream",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "DownloadResult",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"children": [741]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 1,
|
|
"character": 0,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L1"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 782,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorBucketApi.ts#L1"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 846,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorDataApi.ts#L1"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 911,
|
|
"name": "packages/VectorIndexApi",
|
|
"variant": "declaration",
|
|
"kind": 2,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 912,
|
|
"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": 915,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L25"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1252,
|
|
"name": "VectorDataType",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 916,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L26"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 917,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L27"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1254,
|
|
"name": "DistanceMetric",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 914,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L24"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 918,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L28"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1250,
|
|
"name": "MetadataConfiguration",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 913,
|
|
"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/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L23"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [915, 916, 917, 914, 918, 913]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts",
|
|
"line": 22,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L22"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Interfaces",
|
|
"children": [912]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/VectorIndexApi.ts",
|
|
"line": 1,
|
|
"character": 0,
|
|
"url": "https://github.com/supabase/supabase-js/blob/b785a4f1ead99dbbcbd5c43e3d26119cf21a4d90/packages/core/storage-js/src/packages/VectorIndexApi.ts#L1"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Modules",
|
|
"children": [1, 2, 46, 135, 260, 535, 740, 782, 846, 911]
|
|
}
|
|
],
|
|
"packageName": "@supabase/storage-js",
|
|
"readme": [
|
|
{
|
|
"kind": "text",
|
|
"text": "<br />\n<p align=\"center\">\n <a href=\"https://supabase.io\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--dark.svg\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--light.svg\">\n <img alt=\"Supabase Logo\" width=\"300\" src=\"https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/logo-preview.jpg\">\n </picture>\n </a>\n\n <h1 align=\"center\">Supabase Storage JS SDK</h1>\n\n <h3 align=\"center\">JavaScript SDK to interact with Supabase Storage, including file storage and vector embeddings.</h3>\n\n <p align=\"center\">\n <a href=\"https://supabase.com/docs/guides/storage\">Guides</a>\n ·\n <a href=\"https://supabase.com/docs/reference/javascript/storage-createbucket\">Reference Docs</a>\n ·\n <a href=\"https://supabase.github.io/supabase-js/storage-js/v2/spec.json\">TypeDoc</a>\n </p>\n</p>\n\n<div align=\"center\">\n\n[](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[](https://www.npmjs.com/package/@supabase/storage-js)\n[](#license)\n[](https://pkg.pr.new/~/supabase/storage-js)\n\n</div>\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 key for frontend applications\nconst supabase = createClient('https://<project_ref>.supabase.co', '<your-publishable-key>')\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://<project_ref>.supabase.co/storage/v1'\nconst SERVICE_KEY = '<your-secret-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<boolean> {\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<string, string>`"
|
|
},
|
|
{
|
|
"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\npnpm nx build storage-js\n\n# Watch mode for development\npnpm nx build storage-js --watch\n\n# Generate documentation\npnpm 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": "`pnpm exec 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\npnpm 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\npnpm 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)\npnpm nx test:suite storage-js\n\n# Step 3: When done, clean up the infrastructure\npnpm 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)\npnpm nx test:infra storage-js\n\n# Run tests in watch mode\npnpm nx test:suite storage-js --watch\n\n# Clean up when done\npnpm 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": "`pnpm exec 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": "`pnpm 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": "`pnpm 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": "`pnpm 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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"58": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"59": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"60": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"61": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"62": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"63": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"146": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"147": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"148": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"149": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"150": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"151": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/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/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"272": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"273": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"274": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"275": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"276": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"277": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/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.cacheNonce"
|
|
},
|
|
"391": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"392": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"393": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"394": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.signedUrl"
|
|
},
|
|
"395": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"396": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"397": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"398": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"399": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.createSignedUrls"
|
|
},
|
|
"400": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.createSignedUrls"
|
|
},
|
|
"401": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "paths"
|
|
},
|
|
"402": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "expiresIn"
|
|
},
|
|
"403": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"404": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"405": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.download"
|
|
},
|
|
"406": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.cacheNonce"
|
|
},
|
|
"407": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"408": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"409": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"410": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"411": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.path"
|
|
},
|
|
"412": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.signedUrl"
|
|
},
|
|
"413": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"414": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"415": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"416": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"417": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.download"
|
|
},
|
|
"418": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.download"
|
|
},
|
|
"419": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "Options"
|
|
},
|
|
"420": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"421": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.transform"
|
|
},
|
|
"422": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.cacheNonce"
|
|
},
|
|
"423": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"424": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"425": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "parameters"
|
|
},
|
|
"426": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.info"
|
|
},
|
|
"427": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.info"
|
|
},
|
|
"428": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"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": "__type"
|
|
},
|
|
"433": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"434": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"435": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.exists"
|
|
},
|
|
"436": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.exists"
|
|
},
|
|
"437": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"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": "__type"
|
|
},
|
|
"442": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"443": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"444": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.getPublicUrl"
|
|
},
|
|
"445": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.getPublicUrl"
|
|
},
|
|
"446": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"447": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"448": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"449": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.download"
|
|
},
|
|
"450": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.transform"
|
|
},
|
|
"451": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.cacheNonce"
|
|
},
|
|
"452": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"453": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"454": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"455": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.publicUrl"
|
|
},
|
|
"456": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.remove"
|
|
},
|
|
"457": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.remove"
|
|
},
|
|
"458": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "paths"
|
|
},
|
|
"459": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"460": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"461": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"462": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"463": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"464": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"465": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.list"
|
|
},
|
|
"466": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.list"
|
|
},
|
|
"467": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"468": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"469": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "parameters"
|
|
},
|
|
"470": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"471": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"472": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"473": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"474": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"475": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"476": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.listV2"
|
|
},
|
|
"477": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.listV2"
|
|
},
|
|
"478": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"479": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "parameters"
|
|
},
|
|
"480": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"481": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"482": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"483": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"484": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"485": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"489": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.toBase64"
|
|
},
|
|
"490": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.toBase64"
|
|
},
|
|
"491": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "data"
|
|
},
|
|
"517": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"518": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"519": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"520": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"521": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "name"
|
|
},
|
|
"522": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"535": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": ""
|
|
},
|
|
"536": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClientOptions"
|
|
},
|
|
"537": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClientOptions.headers"
|
|
},
|
|
"538": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"539": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"541": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClientOptions.fetch"
|
|
},
|
|
"542": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"543": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"544": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"545": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"546": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"547": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"548": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"549": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient"
|
|
},
|
|
"550": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.__constructor"
|
|
},
|
|
"551": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient"
|
|
},
|
|
"552": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"553": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"554": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.from"
|
|
},
|
|
"555": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.from"
|
|
},
|
|
"556": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"557": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.createBucket"
|
|
},
|
|
"558": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.createBucket"
|
|
},
|
|
"559": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"560": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.getBucket"
|
|
},
|
|
"561": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.getBucket"
|
|
},
|
|
"562": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"563": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"564": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type.vectorBucket"
|
|
},
|
|
"565": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.listBuckets"
|
|
},
|
|
"566": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.listBuckets"
|
|
},
|
|
"567": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"568": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.deleteBucket"
|
|
},
|
|
"569": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.deleteBucket"
|
|
},
|
|
"570": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"586": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"587": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"588": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"589": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"590": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "name"
|
|
},
|
|
"591": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"604": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope"
|
|
},
|
|
"605": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.__constructor"
|
|
},
|
|
"606": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope"
|
|
},
|
|
"607": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"608": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "headers"
|
|
},
|
|
"609": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"610": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"612": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"613": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"614": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"615": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"616": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"617": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"618": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"619": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"620": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"622": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.createIndex"
|
|
},
|
|
"623": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.createIndex"
|
|
},
|
|
"624": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"625": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.listIndexes"
|
|
},
|
|
"626": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.listIndexes"
|
|
},
|
|
"627": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"628": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.getIndex"
|
|
},
|
|
"629": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.getIndex"
|
|
},
|
|
"630": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "indexName"
|
|
},
|
|
"631": {
|
|
"sourceFileName": "src/packages/VectorIndexApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"632": {
|
|
"sourceFileName": "src/packages/VectorIndexApi.ts",
|
|
"qualifiedName": "__type.index"
|
|
},
|
|
"633": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.deleteIndex"
|
|
},
|
|
"634": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.deleteIndex"
|
|
},
|
|
"635": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "indexName"
|
|
},
|
|
"636": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.index"
|
|
},
|
|
"637": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.index"
|
|
},
|
|
"638": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "indexName"
|
|
},
|
|
"654": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"655": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"656": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"657": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"658": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "name"
|
|
},
|
|
"659": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"672": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope"
|
|
},
|
|
"673": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.__constructor"
|
|
},
|
|
"674": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope"
|
|
},
|
|
"675": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"676": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "headers"
|
|
},
|
|
"677": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"678": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"680": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"681": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "indexName"
|
|
},
|
|
"682": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"683": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"684": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"685": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"686": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"687": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"688": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"689": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"692": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.putVectors"
|
|
},
|
|
"693": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.putVectors"
|
|
},
|
|
"694": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"695": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.getVectors"
|
|
},
|
|
"696": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.getVectors"
|
|
},
|
|
"697": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"698": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.listVectors"
|
|
},
|
|
"699": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.listVectors"
|
|
},
|
|
"700": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"701": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.queryVectors"
|
|
},
|
|
"702": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.queryVectors"
|
|
},
|
|
"703": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"704": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.deleteVectors"
|
|
},
|
|
"705": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.deleteVectors"
|
|
},
|
|
"706": {
|
|
"sourceFileName": "src/packages/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"722": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"723": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"724": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"725": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"726": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "name"
|
|
},
|
|
"727": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"740": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": ""
|
|
},
|
|
"741": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"742": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default.__constructor"
|
|
},
|
|
"743": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"744": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "downloadFn"
|
|
},
|
|
"745": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"746": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"747": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "shouldThrowOnError"
|
|
},
|
|
"753": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"754": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"755": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "TResult1"
|
|
},
|
|
"756": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "TResult2"
|
|
},
|
|
"757": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "onfulfilled"
|
|
},
|
|
"758": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"759": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"760": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"761": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "onrejected"
|
|
},
|
|
"762": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"763": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"764": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "reason"
|
|
},
|
|
"765": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default.catch"
|
|
},
|
|
"766": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default.catch"
|
|
},
|
|
"767": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "TResult"
|
|
},
|
|
"768": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "onrejected"
|
|
},
|
|
"769": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"770": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"771": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "reason"
|
|
},
|
|
"772": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default.finally"
|
|
},
|
|
"773": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default.finally"
|
|
},
|
|
"774": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "onfinally"
|
|
},
|
|
"775": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"776": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"781": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default.[toStringTag]"
|
|
},
|
|
"782": {
|
|
"sourceFileName": "src/packages/VectorBucketApi.ts",
|
|
"qualifiedName": ""
|
|
},
|
|
"846": {
|
|
"sourceFileName": "src/packages/VectorDataApi.ts",
|
|
"qualifiedName": ""
|
|
},
|
|
"911": {
|
|
"sourceFileName": "src/packages/VectorIndexApi.ts",
|
|
"qualifiedName": ""
|
|
},
|
|
"912": {
|
|
"sourceFileName": "src/packages/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions"
|
|
},
|
|
"913": {
|
|
"sourceFileName": "src/packages/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.vectorBucketName"
|
|
},
|
|
"914": {
|
|
"sourceFileName": "src/packages/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.indexName"
|
|
},
|
|
"915": {
|
|
"sourceFileName": "src/packages/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.dataType"
|
|
},
|
|
"916": {
|
|
"sourceFileName": "src/packages/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.dimension"
|
|
},
|
|
"917": {
|
|
"sourceFileName": "src/packages/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.distanceMetric"
|
|
},
|
|
"918": {
|
|
"sourceFileName": "src/packages/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.metadataConfiguration"
|
|
},
|
|
"984": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient"
|
|
},
|
|
"985": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.__constructor"
|
|
},
|
|
"986": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient"
|
|
},
|
|
"987": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"988": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "headers"
|
|
},
|
|
"989": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"990": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"992": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"993": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"994": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"995": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"996": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"997": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"998": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"999": {
|
|
"sourceFileName": "../../../node_modules/.pnpm/@types+node@20.19.9/node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"1000": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "opts"
|
|
},
|
|
"1001": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.from"
|
|
},
|
|
"1002": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.from"
|
|
},
|
|
"1003": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"1004": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.vectors"
|
|
},
|
|
"1005": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.vectors"
|
|
},
|
|
"1006": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.analytics"
|
|
},
|
|
"1007": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.analytics"
|
|
},
|
|
"1008": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.listBuckets"
|
|
},
|
|
"1009": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.listBuckets"
|
|
},
|
|
"1010": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"1011": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1012": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1013": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"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": "default.getBucket"
|
|
},
|
|
"1018": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.getBucket"
|
|
},
|
|
"1019": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"1020": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1021": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1022": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1023": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1024": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1025": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1026": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.createBucket"
|
|
},
|
|
"1027": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.createBucket"
|
|
},
|
|
"1028": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"1029": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"1030": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1031": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.public"
|
|
},
|
|
"1032": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.fileSizeLimit"
|
|
},
|
|
"1033": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.allowedMimeTypes"
|
|
},
|
|
"1034": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.type"
|
|
},
|
|
"1035": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1036": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1037": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1038": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1039": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1040": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1041": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.updateBucket"
|
|
},
|
|
"1042": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.updateBucket"
|
|
},
|
|
"1043": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"1044": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"1045": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1046": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.public"
|
|
},
|
|
"1047": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.fileSizeLimit"
|
|
},
|
|
"1048": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.allowedMimeTypes"
|
|
},
|
|
"1049": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1050": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1051": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1052": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"1053": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1054": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1055": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1056": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1057": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.emptyBucket"
|
|
},
|
|
"1058": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.emptyBucket"
|
|
},
|
|
"1059": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"1060": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1061": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1062": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1063": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"1064": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1065": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1066": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1067": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1068": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.deleteBucket"
|
|
},
|
|
"1069": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.deleteBucket"
|
|
},
|
|
"1070": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"1071": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1072": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1073": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1074": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"1075": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1076": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1077": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1078": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1094": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"1095": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"1096": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"1097": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"1098": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "name"
|
|
},
|
|
"1099": {
|
|
"sourceFileName": "src/lib/common/BaseApiClient.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"1112": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClientOptions"
|
|
},
|
|
"1113": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClientOptions.useNewHostname"
|
|
},
|
|
"1114": {
|
|
"sourceFileName": "src/index.ts",
|
|
"qualifiedName": "StorageAnalyticsClient"
|
|
},
|
|
"1115": {
|
|
"sourceFileName": "src/index.ts",
|
|
"qualifiedName": "StorageVectorsClient"
|
|
},
|
|
"1116": {
|
|
"sourceFileName": "src/index.ts",
|
|
"qualifiedName": "VectorBucketScope"
|
|
},
|
|
"1117": {
|
|
"sourceFileName": "src/index.ts",
|
|
"qualifiedName": "VectorIndexScope"
|
|
},
|
|
"1118": {
|
|
"sourceFileName": "src/index.ts",
|
|
"qualifiedName": "StorageVectorsClientOptions"
|
|
},
|
|
"1122": {
|
|
"sourceFileName": "src/index.ts",
|
|
"qualifiedName": "CreateIndexOptions"
|
|
},
|
|
"1123": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "BucketType"
|
|
},
|
|
"1124": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1125": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket"
|
|
},
|
|
"1126": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.id"
|
|
},
|
|
"1127": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.type"
|
|
},
|
|
"1128": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.name"
|
|
},
|
|
"1129": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.owner"
|
|
},
|
|
"1130": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.file_size_limit"
|
|
},
|
|
"1131": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.allowed_mime_types"
|
|
},
|
|
"1132": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.created_at"
|
|
},
|
|
"1133": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.updated_at"
|
|
},
|
|
"1134": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.public"
|
|
},
|
|
"1135": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions"
|
|
},
|
|
"1136": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions.limit"
|
|
},
|
|
"1137": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions.offset"
|
|
},
|
|
"1138": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions.sortColumn"
|
|
},
|
|
"1139": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions.sortOrder"
|
|
},
|
|
"1140": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions.search"
|
|
},
|
|
"1141": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket"
|
|
},
|
|
"1142": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket.name"
|
|
},
|
|
"1143": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket.type"
|
|
},
|
|
"1144": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket.format"
|
|
},
|
|
"1145": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket.created_at"
|
|
},
|
|
"1146": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket.updated_at"
|
|
},
|
|
"1147": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileMetadata"
|
|
},
|
|
"1148": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileMetadata.eTag"
|
|
},
|
|
"1149": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileMetadata.size"
|
|
},
|
|
"1150": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileMetadata.mimetype"
|
|
},
|
|
"1151": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileMetadata.cacheControl"
|
|
},
|
|
"1152": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileMetadata.lastModified"
|
|
},
|
|
"1153": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileMetadata.contentLength"
|
|
},
|
|
"1154": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileMetadata.httpStatusCode"
|
|
},
|
|
"1155": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileMetadata.__index"
|
|
},
|
|
"1157": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject"
|
|
},
|
|
"1158": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.name"
|
|
},
|
|
"1159": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.id"
|
|
},
|
|
"1160": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.updated_at"
|
|
},
|
|
"1161": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.created_at"
|
|
},
|
|
"1162": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.last_accessed_at"
|
|
},
|
|
"1163": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.metadata"
|
|
},
|
|
"1164": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.bucket_id"
|
|
},
|
|
"1165": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.owner"
|
|
},
|
|
"1166": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.buckets"
|
|
},
|
|
"1167": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2"
|
|
},
|
|
"1168": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.id"
|
|
},
|
|
"1169": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.version"
|
|
},
|
|
"1170": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.name"
|
|
},
|
|
"1171": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.bucket_id"
|
|
},
|
|
"1172": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.created_at"
|
|
},
|
|
"1173": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.size"
|
|
},
|
|
"1174": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.cache_control"
|
|
},
|
|
"1175": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.content_type"
|
|
},
|
|
"1176": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.etag"
|
|
},
|
|
"1177": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.last_modified"
|
|
},
|
|
"1178": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.metadata"
|
|
},
|
|
"1179": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.updated_at"
|
|
},
|
|
"1180": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortBy"
|
|
},
|
|
"1181": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortBy.column"
|
|
},
|
|
"1182": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortBy.order"
|
|
},
|
|
"1183": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions"
|
|
},
|
|
"1184": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.cacheControl"
|
|
},
|
|
"1185": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.contentType"
|
|
},
|
|
"1186": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.upsert"
|
|
},
|
|
"1187": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.duplex"
|
|
},
|
|
"1188": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.metadata"
|
|
},
|
|
"1189": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.headers"
|
|
},
|
|
"1190": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "DestinationOptions"
|
|
},
|
|
"1191": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "DestinationOptions.destinationBucket"
|
|
},
|
|
"1192": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchOptions"
|
|
},
|
|
"1193": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchOptions.limit"
|
|
},
|
|
"1194": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchOptions.offset"
|
|
},
|
|
"1195": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchOptions.sortBy"
|
|
},
|
|
"1196": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchOptions.search"
|
|
},
|
|
"1197": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortByV2"
|
|
},
|
|
"1198": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortByV2.column"
|
|
},
|
|
"1199": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortByV2.order"
|
|
},
|
|
"1200": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options"
|
|
},
|
|
"1201": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options.limit"
|
|
},
|
|
"1202": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options.prefix"
|
|
},
|
|
"1203": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options.cursor"
|
|
},
|
|
"1204": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options.with_delimiter"
|
|
},
|
|
"1205": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options.sortBy"
|
|
},
|
|
"1206": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object"
|
|
},
|
|
"1207": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.name"
|
|
},
|
|
"1208": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.key"
|
|
},
|
|
"1209": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.id"
|
|
},
|
|
"1210": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.updated_at"
|
|
},
|
|
"1211": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.created_at"
|
|
},
|
|
"1212": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.metadata"
|
|
},
|
|
"1213": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.last_accessed_at"
|
|
},
|
|
"1214": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Folder"
|
|
},
|
|
"1215": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Folder.name"
|
|
},
|
|
"1216": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Folder.key"
|
|
},
|
|
"1217": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Result"
|
|
},
|
|
"1218": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Result.hasNext"
|
|
},
|
|
"1219": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Result.folders"
|
|
},
|
|
"1220": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Result.objects"
|
|
},
|
|
"1221": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Result.nextCursor"
|
|
},
|
|
"1222": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FetchParameters"
|
|
},
|
|
"1223": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FetchParameters.signal"
|
|
},
|
|
"1224": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FetchParameters.cache"
|
|
},
|
|
"1225": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Metadata"
|
|
},
|
|
"1226": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Metadata.name"
|
|
},
|
|
"1227": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions"
|
|
},
|
|
"1228": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions.width"
|
|
},
|
|
"1229": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions.height"
|
|
},
|
|
"1230": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions.resize"
|
|
},
|
|
"1231": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions.quality"
|
|
},
|
|
"1232": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions.format"
|
|
},
|
|
"1233": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Camelize"
|
|
},
|
|
"1234": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "T"
|
|
},
|
|
"1235": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "DownloadResult"
|
|
},
|
|
"1236": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1237": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1238": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1239": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1240": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"1241": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"1242": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "T"
|
|
},
|
|
"1243": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "EncryptionConfiguration"
|
|
},
|
|
"1244": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "EncryptionConfiguration.kmsKeyArn"
|
|
},
|
|
"1245": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "EncryptionConfiguration.sseType"
|
|
},
|
|
"1246": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorBucket"
|
|
},
|
|
"1247": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorBucket.vectorBucketName"
|
|
},
|
|
"1248": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorBucket.creationTime"
|
|
},
|
|
"1249": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorBucket.encryptionConfiguration"
|
|
},
|
|
"1250": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "MetadataConfiguration"
|
|
},
|
|
"1251": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "MetadataConfiguration.nonFilterableMetadataKeys"
|
|
},
|
|
"1252": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorDataType"
|
|
},
|
|
"1253": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1254": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "DistanceMetric"
|
|
},
|
|
"1255": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1256": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorIndex"
|
|
},
|
|
"1257": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorIndex.indexName"
|
|
},
|
|
"1258": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorIndex.vectorBucketName"
|
|
},
|
|
"1259": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorIndex.dataType"
|
|
},
|
|
"1260": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorIndex.dimension"
|
|
},
|
|
"1261": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorIndex.distanceMetric"
|
|
},
|
|
"1262": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorIndex.metadataConfiguration"
|
|
},
|
|
"1263": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorIndex.creationTime"
|
|
},
|
|
"1264": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorData"
|
|
},
|
|
"1265": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorData.float32"
|
|
},
|
|
"1266": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorMetadata"
|
|
},
|
|
"1267": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorObject"
|
|
},
|
|
"1268": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorObject.key"
|
|
},
|
|
"1269": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorObject.data"
|
|
},
|
|
"1270": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorObject.metadata"
|
|
},
|
|
"1271": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorMatch"
|
|
},
|
|
"1272": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorMatch.key"
|
|
},
|
|
"1273": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorMatch.data"
|
|
},
|
|
"1274": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorMatch.metadata"
|
|
},
|
|
"1275": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorMatch.distance"
|
|
},
|
|
"1276": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorBucketsOptions"
|
|
},
|
|
"1277": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorBucketsOptions.prefix"
|
|
},
|
|
"1278": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorBucketsOptions.maxResults"
|
|
},
|
|
"1279": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorBucketsOptions.nextToken"
|
|
},
|
|
"1280": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorBucketsResponse"
|
|
},
|
|
"1281": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorBucketsResponse.vectorBuckets"
|
|
},
|
|
"1282": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1283": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type.vectorBucketName"
|
|
},
|
|
"1284": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorBucketsResponse.nextToken"
|
|
},
|
|
"1285": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListIndexesOptions"
|
|
},
|
|
"1286": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListIndexesOptions.vectorBucketName"
|
|
},
|
|
"1287": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListIndexesOptions.prefix"
|
|
},
|
|
"1288": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListIndexesOptions.maxResults"
|
|
},
|
|
"1289": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListIndexesOptions.nextToken"
|
|
},
|
|
"1290": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListIndexesResponse"
|
|
},
|
|
"1291": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListIndexesResponse.indexes"
|
|
},
|
|
"1292": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1293": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type.indexName"
|
|
},
|
|
"1294": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListIndexesResponse.nextToken"
|
|
},
|
|
"1295": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "GetVectorsOptions"
|
|
},
|
|
"1296": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "GetVectorsOptions.vectorBucketName"
|
|
},
|
|
"1297": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "GetVectorsOptions.indexName"
|
|
},
|
|
"1298": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "GetVectorsOptions.keys"
|
|
},
|
|
"1299": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "GetVectorsOptions.returnData"
|
|
},
|
|
"1300": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "GetVectorsOptions.returnMetadata"
|
|
},
|
|
"1301": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "GetVectorsResponse"
|
|
},
|
|
"1302": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "GetVectorsResponse.vectors"
|
|
},
|
|
"1303": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "PutVectorsOptions"
|
|
},
|
|
"1304": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "PutVectorsOptions.vectorBucketName"
|
|
},
|
|
"1305": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "PutVectorsOptions.indexName"
|
|
},
|
|
"1306": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "PutVectorsOptions.vectors"
|
|
},
|
|
"1307": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "DeleteVectorsOptions"
|
|
},
|
|
"1308": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "DeleteVectorsOptions.vectorBucketName"
|
|
},
|
|
"1309": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "DeleteVectorsOptions.indexName"
|
|
},
|
|
"1310": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "DeleteVectorsOptions.keys"
|
|
},
|
|
"1311": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsOptions"
|
|
},
|
|
"1312": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.vectorBucketName"
|
|
},
|
|
"1313": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.indexName"
|
|
},
|
|
"1314": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.maxResults"
|
|
},
|
|
"1315": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.nextToken"
|
|
},
|
|
"1316": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.returnData"
|
|
},
|
|
"1317": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.returnMetadata"
|
|
},
|
|
"1318": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.segmentCount"
|
|
},
|
|
"1319": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.segmentIndex"
|
|
},
|
|
"1320": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsResponse"
|
|
},
|
|
"1321": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsResponse.vectors"
|
|
},
|
|
"1322": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListVectorsResponse.nextToken"
|
|
},
|
|
"1323": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorFilter"
|
|
},
|
|
"1324": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions"
|
|
},
|
|
"1325": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.vectorBucketName"
|
|
},
|
|
"1326": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.indexName"
|
|
},
|
|
"1327": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.queryVector"
|
|
},
|
|
"1328": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.topK"
|
|
},
|
|
"1329": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.filter"
|
|
},
|
|
"1330": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.returnDistance"
|
|
},
|
|
"1331": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.returnMetadata"
|
|
},
|
|
"1332": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "QueryVectorsResponse"
|
|
},
|
|
"1333": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "QueryVectorsResponse.vectors"
|
|
},
|
|
"1334": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "QueryVectorsResponse.distanceMetric"
|
|
},
|
|
"1335": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorFetchParameters"
|
|
},
|
|
"1336": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "VectorFetchParameters.signal"
|
|
},
|
|
"1337": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SuccessResponse"
|
|
},
|
|
"1338": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SuccessResponse.data"
|
|
},
|
|
"1339": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SuccessResponse.error"
|
|
},
|
|
"1340": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SuccessResponse.T"
|
|
},
|
|
"1341": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ErrorResponse"
|
|
},
|
|
"1342": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ErrorResponse.data"
|
|
},
|
|
"1343": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ErrorResponse.error"
|
|
},
|
|
"1344": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ApiResponse"
|
|
},
|
|
"1345": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "T"
|
|
},
|
|
"1346": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "isStorageError"
|
|
},
|
|
"1347": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "isStorageError"
|
|
},
|
|
"1348": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "error"
|
|
},
|
|
"1349": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "isStorageVectorsError"
|
|
},
|
|
"1350": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "isStorageVectorsError"
|
|
},
|
|
"1351": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "error"
|
|
},
|
|
"1352": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "ErrorNamespace"
|
|
},
|
|
"1353": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError"
|
|
},
|
|
"1354": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.__constructor"
|
|
},
|
|
"1355": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError"
|
|
},
|
|
"1356": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"1357": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "namespace"
|
|
},
|
|
"1358": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "status"
|
|
},
|
|
"1359": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "statusCode"
|
|
},
|
|
"1362": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.status"
|
|
},
|
|
"1363": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.statusCode"
|
|
},
|
|
"1364": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.toJSON"
|
|
},
|
|
"1365": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.toJSON"
|
|
},
|
|
"1366": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1367": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.name"
|
|
},
|
|
"1368": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"1369": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.status"
|
|
},
|
|
"1370": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.statusCode"
|
|
},
|
|
"1371": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageApiError"
|
|
},
|
|
"1372": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageApiError.__constructor"
|
|
},
|
|
"1373": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageApiError"
|
|
},
|
|
"1374": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"1375": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "status"
|
|
},
|
|
"1376": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "statusCode"
|
|
},
|
|
"1377": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "namespace"
|
|
},
|
|
"1378": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageApiError.status"
|
|
},
|
|
"1379": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageApiError.statusCode"
|
|
},
|
|
"1380": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageApiError.toJSON"
|
|
},
|
|
"1381": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageApiError.toJSON"
|
|
},
|
|
"1382": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1383": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.name"
|
|
},
|
|
"1384": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"1385": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.status"
|
|
},
|
|
"1386": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.statusCode"
|
|
},
|
|
"1389": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageUnknownError"
|
|
},
|
|
"1390": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageUnknownError.__constructor"
|
|
},
|
|
"1391": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageUnknownError"
|
|
},
|
|
"1392": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"1393": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "originalError"
|
|
},
|
|
"1394": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "namespace"
|
|
},
|
|
"1395": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageUnknownError.originalError"
|
|
},
|
|
"1398": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.status"
|
|
},
|
|
"1399": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.statusCode"
|
|
},
|
|
"1400": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.toJSON"
|
|
},
|
|
"1401": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.toJSON"
|
|
},
|
|
"1402": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1403": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.name"
|
|
},
|
|
"1404": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"1405": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.status"
|
|
},
|
|
"1406": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.statusCode"
|
|
},
|
|
"1407": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsError"
|
|
},
|
|
"1408": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsError.__constructor"
|
|
},
|
|
"1409": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsError"
|
|
},
|
|
"1410": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"1413": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.status"
|
|
},
|
|
"1414": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.statusCode"
|
|
},
|
|
"1415": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.toJSON"
|
|
},
|
|
"1416": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.toJSON"
|
|
},
|
|
"1417": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1418": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.name"
|
|
},
|
|
"1419": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"1420": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.status"
|
|
},
|
|
"1421": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.statusCode"
|
|
},
|
|
"1422": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsApiError"
|
|
},
|
|
"1423": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsApiError.__constructor"
|
|
},
|
|
"1424": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsApiError"
|
|
},
|
|
"1425": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"1426": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "status"
|
|
},
|
|
"1427": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "statusCode"
|
|
},
|
|
"1428": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageApiError.status"
|
|
},
|
|
"1429": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageApiError.statusCode"
|
|
},
|
|
"1430": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageApiError.toJSON"
|
|
},
|
|
"1431": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageApiError.toJSON"
|
|
},
|
|
"1432": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1433": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.name"
|
|
},
|
|
"1434": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"1435": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.status"
|
|
},
|
|
"1436": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.statusCode"
|
|
},
|
|
"1439": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsUnknownError"
|
|
},
|
|
"1440": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsUnknownError.__constructor"
|
|
},
|
|
"1441": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsUnknownError"
|
|
},
|
|
"1442": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"1443": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "originalError"
|
|
},
|
|
"1444": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageUnknownError.originalError"
|
|
},
|
|
"1447": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.status"
|
|
},
|
|
"1448": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.statusCode"
|
|
},
|
|
"1449": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.toJSON"
|
|
},
|
|
"1450": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageError.toJSON"
|
|
},
|
|
"1451": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1452": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.name"
|
|
},
|
|
"1453": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"1454": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.status"
|
|
},
|
|
"1455": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "__type.statusCode"
|
|
},
|
|
"1456": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode"
|
|
},
|
|
"1457": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode.InternalError"
|
|
},
|
|
"1458": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode.S3VectorConflictException"
|
|
},
|
|
"1459": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode.S3VectorNotFoundException"
|
|
},
|
|
"1460": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode.S3VectorBucketNotEmpty"
|
|
},
|
|
"1461": {
|
|
"sourceFileName": "src/lib/common/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode.S3VectorMaxBucketsExceeded"
|
|
},
|
|
"1462": {
|
|
"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": 535,
|
|
"7": 740,
|
|
"8": 782,
|
|
"9": 846,
|
|
"10": 911
|
|
}
|
|
}
|
|
}
|