mirror of
https://github.com/supabase/supabase.git
synced 2026-10-14 13:49:09 +03:00
5a0379d5c5
Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com> Co-authored-by: Katerina Skroumpelou <mandarini@users.noreply.github.com>
31490 lines
1.2 MiB
Plaintext
31490 lines
1.2 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": 1186,
|
|
"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": 1187,
|
|
"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/vectors/errors.ts",
|
|
"line": 67,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L67"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "InternalError"
|
|
}
|
|
},
|
|
{
|
|
"id": 1190,
|
|
"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/vectors/errors.ts",
|
|
"line": 73,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L73"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "S3VectorBucketNotEmpty"
|
|
}
|
|
},
|
|
{
|
|
"id": 1188,
|
|
"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/vectors/errors.ts",
|
|
"line": 69,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L69"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "S3VectorConflictException"
|
|
}
|
|
},
|
|
{
|
|
"id": 1191,
|
|
"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/vectors/errors.ts",
|
|
"line": 75,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L75"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "S3VectorMaxBucketsExceeded"
|
|
}
|
|
},
|
|
{
|
|
"id": 1192,
|
|
"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/vectors/errors.ts",
|
|
"line": 77,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L77"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "S3VectorMaxIndexesExceeded"
|
|
}
|
|
},
|
|
{
|
|
"id": 1189,
|
|
"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/vectors/errors.ts",
|
|
"line": 71,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L71"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "S3VectorNotFoundException"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Enumeration Members",
|
|
"children": [1187, 1190, 1188, 1191, 1192, 1189]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 65,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L65"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 733,
|
|
"name": "StorageApiError",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 734,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 18,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L18"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 735,
|
|
"name": "StorageApiError",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 18,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L18"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 736,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 737,
|
|
"name": "status",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 738,
|
|
"name": "statusCode",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 733,
|
|
"name": "StorageApiError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 730,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 729,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 739,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 15,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L15"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 740,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 16,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L16"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 741,
|
|
"name": "toJSON",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 25,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L25"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 742,
|
|
"name": "toJSON",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 25,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L25"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 743,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 745,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 28,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L28"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 744,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 27,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L27"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 746,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 29,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L29"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 747,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 30,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L30"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [745, 744, 746, 747]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 26,
|
|
"character": 11,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L26"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [734]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [739, 740]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [741]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 14,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L14"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 504,
|
|
"name": "StorageClient",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 505,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 26,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L26"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 506,
|
|
"name": "StorageClient",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a client for Storage buckets, files, analytics, and vectors."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nimport { StorageClient } from '@supabase/storage-js'\n\nconst storage = new StorageClient('https://xyzcompany.supabase.co/storage/v1', {\n apikey: 'public-anon-key',\n})\nconst avatars = storage.from('avatars')\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 26,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L26"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 507,
|
|
"name": "url",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 508,
|
|
"name": "headers",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 509,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 28,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L28"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 510,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 28,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L28"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 511,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 512,
|
|
"name": "fetch",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 513,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 514,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 515,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 516,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 517,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 518,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 519,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 520,
|
|
"name": "opts",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 615,
|
|
"name": "StorageClientOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 504,
|
|
"name": "StorageClient",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 121,
|
|
"name": "default.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 120,
|
|
"name": "default.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 526,
|
|
"name": "analytics",
|
|
"variant": "declaration",
|
|
"kind": 262144,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 79,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L79"
|
|
}
|
|
],
|
|
"getSignature": {
|
|
"id": 527,
|
|
"name": "analytics",
|
|
"variant": "signature",
|
|
"kind": 524288,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Access analytics storage operations using Iceberg tables.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Analytics Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "A StorageAnalyticsClient instance configured with the current storage settings."
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 79,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L79"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 48,
|
|
"name": "StorageAnalyticsClient",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 524,
|
|
"name": "vectors",
|
|
"variant": "declaration",
|
|
"kind": 262144,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 61,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L61"
|
|
}
|
|
],
|
|
"getSignature": {
|
|
"id": 525,
|
|
"name": "vectors",
|
|
"variant": "signature",
|
|
"kind": 524288,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Access vector storage operations.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "A StorageVectorsClient instance configured with the current storage settings."
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 61,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L61"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 756,
|
|
"name": "StorageVectorsClient",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 562,
|
|
"name": "createBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 201,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 563,
|
|
"name": "createBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a new Storage bucket"
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing newly created bucket name or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Create bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .createBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"name\": \"avatars\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 201,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 564,
|
|
"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": 565,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 566,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 569,
|
|
"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": 206,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L206"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 568,
|
|
"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": 205,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L205"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 567,
|
|
"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": 204,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L204"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 570,
|
|
"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": 207,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L207"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 618,
|
|
"name": "BucketType",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [569, 568, 567, 570]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 203,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L203"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 571,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 572,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 213,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L213"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Pick"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 619,
|
|
"name": "Bucket",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "name"
|
|
}
|
|
],
|
|
"name": "Pick",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 573,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 214,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L214"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [572, 573]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 212,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L212"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 574,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 575,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 217,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L217"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 576,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 218,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L218"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [575, 576]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 216,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L216"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 171,
|
|
"name": "default.createBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 170,
|
|
"name": "default.createBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 604,
|
|
"name": "deleteBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 405,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L405"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 605,
|
|
"name": "deleteBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`empty()`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " the bucket."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with success message or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Delete bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .deleteBucket('avatars')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 405,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L405"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 606,
|
|
"name": "id",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The unique identifier of the bucket you would like to delete."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 607,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 608,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 407,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L407"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 609,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 610,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 407,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L407"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [610]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 407,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L407"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 611,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 408,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L408"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [608, 611]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 406,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L406"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 612,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 613,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 411,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L411"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 614,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 412,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L412"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [613, 614]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 410,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L410"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 213,
|
|
"name": "default.deleteBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 212,
|
|
"name": "default.deleteBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 593,
|
|
"name": "emptyBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 350,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L350"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 594,
|
|
"name": "emptyBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Removes all objects inside a single bucket."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with success message or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Empty bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .emptyBucket('avatars')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"message\": \"Successfully emptied\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 350,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L350"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 595,
|
|
"name": "id",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The unique identifier of the bucket you would like to empty."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 596,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 597,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 352,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L352"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 598,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 599,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 352,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L352"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [599]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 352,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L352"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 600,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 353,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L353"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [597, 600]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 351,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L351"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 601,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 602,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 356,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L356"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 603,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 357,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L357"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [602, 603]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 355,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L355"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 202,
|
|
"name": "default.emptyBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 201,
|
|
"name": "default.emptyBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 521,
|
|
"name": "from",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 46,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L46"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 522,
|
|
"name": "from",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Perform file operation in a bucket."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```typescript\nconst avatars = supabase.storage.from('avatars')\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 46,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L46"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 523,
|
|
"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": 227,
|
|
"name": "StorageFileApi",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 553,
|
|
"name": "getBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 139,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L139"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 554,
|
|
"name": "getBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Retrieves the details of an existing Storage bucket."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing bucket details or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Get bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .getBucket('avatars')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"id\": \"avatars\",\n \"name\": \"avatars\",\n \"owner\": \"\",\n \"public\": false,\n \"file_size_limit\": 1024,\n \"allowed_mime_types\": [\n \"image/png\"\n ],\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 139,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L139"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 555,
|
|
"name": "id",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The unique identifier of the bucket you would like to retrieve."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 556,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 557,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 141,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L141"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 619,
|
|
"name": "Bucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 558,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 142,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L142"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [557, 558]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 140,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L140"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 559,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 560,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 145,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L145"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 561,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 146,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L146"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [560, 561]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 144,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L144"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 162,
|
|
"name": "default.getBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 161,
|
|
"name": "default.getBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 544,
|
|
"name": "listBuckets",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 78,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 545,
|
|
"name": "listBuckets",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Retrieves the details of all Storage buckets within an existing project."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing array of buckets or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "List buckets",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets()\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "List buckets with options",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod'\n })\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 78,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 546,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Query parameters for listing buckets"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 629,
|
|
"name": "ListBucketOptions",
|
|
"package": "@supabase/storage-js",
|
|
"highlightedProperties": {
|
|
"limit": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Maximum number of buckets to return"
|
|
}
|
|
],
|
|
"offset": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Number of buckets to skip"
|
|
}
|
|
],
|
|
"sortColumn": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Column to sort by ('id', 'name', 'created_at', 'updated_at')"
|
|
}
|
|
],
|
|
"sortOrder": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Sort order ('asc' or 'desc')"
|
|
}
|
|
],
|
|
"search": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Search term to filter bucket names"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 547,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 548,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 80,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L80"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 619,
|
|
"name": "Bucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 549,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 81,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L81"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [548, 549]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 79,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L79"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 550,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 551,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 84,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L84"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 552,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 85,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L85"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [551, 552]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 83,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L83"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 153,
|
|
"name": "default.listBuckets"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 152,
|
|
"name": "default.listBuckets"
|
|
}
|
|
},
|
|
{
|
|
"id": 542,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 41,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L41"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 543,
|
|
"name": "throwOnError",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Enable throwing errors instead of returning them."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 41,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L41"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 151,
|
|
"name": "default.throwOnError"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 150,
|
|
"name": "default.throwOnError"
|
|
}
|
|
},
|
|
{
|
|
"id": 577,
|
|
"name": "updateBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 283,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L283"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 578,
|
|
"name": "updateBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Updates a Storage bucket"
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing success message or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Update bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .updateBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"message\": \"Successfully updated\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 283,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L283"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 579,
|
|
"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": 580,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 581,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 584,
|
|
"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": 288,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L288"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 583,
|
|
"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": 287,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L287"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 582,
|
|
"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": 286,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L286"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [584, 583, 582]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 285,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L285"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 585,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 586,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 292,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L292"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 587,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 588,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 292,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L292"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [588]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 292,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L292"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 589,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 293,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L293"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [586, 589]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 291,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L291"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 590,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 591,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 296,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L296"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 592,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 297,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L297"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [591, 592]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 295,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L295"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"name": "default.updateBucket"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 185,
|
|
"name": "default.updateBucket"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [505]
|
|
},
|
|
{
|
|
"title": "Accessors",
|
|
"children": [526, 524]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [562, 604, 593, 521, 553, 544, 542, 577]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Analytics Buckets",
|
|
"children": [526]
|
|
},
|
|
{
|
|
"title": "File Buckets",
|
|
"children": [505, 562, 604, 593, 521, 553, 544, 542, 577]
|
|
},
|
|
{
|
|
"title": "Vector Buckets",
|
|
"children": [524]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 11,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L11"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 119,
|
|
"name": "default",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 728,
|
|
"name": "StorageError",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 729,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 4,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L4"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 730,
|
|
"name": "StorageError",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 4,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L4"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 731,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Error.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Error.constructor"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [729]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 1,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L1"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Error"
|
|
},
|
|
"name": "Error",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"target": 733,
|
|
"name": "StorageApiError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 749,
|
|
"name": "StorageUnknownError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 749,
|
|
"name": "StorageUnknownError",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 750,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 38,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L38"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 751,
|
|
"name": "StorageUnknownError",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 38,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L38"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 752,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 753,
|
|
"name": "originalError",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 749,
|
|
"name": "StorageUnknownError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 730,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 729,
|
|
"name": "StorageError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 754,
|
|
"name": "originalError",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 36,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L36"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [750]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [754]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 35,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L35"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1163,
|
|
"name": "StorageVectorsApiError",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "API error returned from S3 Vectors service\nIncludes HTTP status code and service-specific error code"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1164,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 30,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L30"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1165,
|
|
"name": "StorageVectorsApiError",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 30,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L30"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1166,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1167,
|
|
"name": "status",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1168,
|
|
"name": "statusCode",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1163,
|
|
"name": "StorageVectorsApiError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1160,
|
|
"name": "StorageVectorsError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1159,
|
|
"name": "StorageVectorsError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1169,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 27,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L27"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1170,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 28,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L28"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1171,
|
|
"name": "toJSON",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 37,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L37"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1172,
|
|
"name": "toJSON",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 37,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L37"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1173,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1175,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 40,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L40"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1174,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 39,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L39"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1176,
|
|
"name": "status",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 41,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L41"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 1177,
|
|
"name": "statusCode",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 42,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L42"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1175, 1174, 1176, 1177]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 38,
|
|
"character": 11,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L38"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [1164]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [1169, 1170]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [1171]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 26,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L26"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1158,
|
|
"name": "StorageVectorsError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 756,
|
|
"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": 757,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 98,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L98"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 758,
|
|
"name": "StorageVectorsClient",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a StorageVectorsClient that can manage buckets, indexes, and vectors.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```typescript\nconst client = new StorageVectorsClient(url, options)\n```"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 98,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L98"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 759,
|
|
"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": 760,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 896,
|
|
"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": 756,
|
|
"name": "StorageVectorsClient",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorBucketApi.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorBucketApi.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 764,
|
|
"name": "createBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 145,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L145"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 765,
|
|
"name": "createBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a new vector bucket\nVector buckets are containers for vector indexes and their data\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with empty response on success or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 145,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L145"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 766,
|
|
"name": "vectorBucketName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Unique name for the vector bucket"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"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": 775,
|
|
"name": "deleteBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 226,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L226"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 776,
|
|
"name": "deleteBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Deletes a vector bucket (bucket must be empty)\nAll indexes must be deleted before deleting the bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with empty response on success or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 226,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L226"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 777,
|
|
"name": "vectorBucketName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Name of the vector bucket to delete"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"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": 761,
|
|
"name": "from",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 120,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L120"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 762,
|
|
"name": "from",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Access operations for a specific vector bucket\nReturns a scoped client for index and vector operations within the bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Bucket-scoped client with index and vector operations"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 120,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L120"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 763,
|
|
"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": 794,
|
|
"name": "VectorBucketScope",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 767,
|
|
"name": "getBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 171,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L171"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 768,
|
|
"name": "getBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Retrieves metadata for a specific vector bucket\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with bucket metadata or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 171,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L171"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 769,
|
|
"name": "vectorBucketName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Name of the vector bucket"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 770,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 771,
|
|
"name": "vectorBucket",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 171,
|
|
"character": 67,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L171"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1057,
|
|
"name": "VectorBucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [771]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 171,
|
|
"character": 65,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L171"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"name": "ApiResponse",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorBucketApi.getBucket"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorBucketApi.getBucket"
|
|
}
|
|
},
|
|
{
|
|
"id": 772,
|
|
"name": "listBuckets",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 199,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L199"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 773,
|
|
"name": "listBuckets",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Lists all vector buckets with optional filtering and pagination\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with list of buckets or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 199,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L199"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 774,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Optional filters (prefix, maxResults, nextToken)"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1089,
|
|
"name": "ListVectorBucketsOptions",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1093,
|
|
"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": 792,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorBucketApi.ts",
|
|
"line": 31,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorBucketApi.ts#L31"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 793,
|
|
"name": "throwOnError",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Enable throwing errors instead of returning them in the response"
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorBucketApi.ts",
|
|
"line": 31,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorBucketApi.ts#L31"
|
|
}
|
|
],
|
|
"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": [757]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [764, 775, 761, 767, 772, 792]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Other",
|
|
"children": [792]
|
|
},
|
|
{
|
|
"title": "Vector Buckets",
|
|
"children": [757, 764, 775, 761, 767, 772]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 80,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L80"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "default",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1158,
|
|
"name": "StorageVectorsError",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Base error class for all Storage Vectors errors"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1159,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 7,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L7"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1160,
|
|
"name": "StorageVectorsError",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 7,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L7"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1161,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1158,
|
|
"name": "StorageVectorsError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Error.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Error.constructor"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [1159]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 4,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L4"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Error"
|
|
},
|
|
"name": "Error",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1163,
|
|
"name": "StorageVectorsApiError"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 1179,
|
|
"name": "StorageVectorsUnknownError"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1179,
|
|
"name": "StorageVectorsUnknownError",
|
|
"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": 1180,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 54,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L54"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1181,
|
|
"name": "StorageVectorsUnknownError",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 54,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L54"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1182,
|
|
"name": "message",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1183,
|
|
"name": "originalError",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1179,
|
|
"name": "StorageVectorsUnknownError",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1160,
|
|
"name": "StorageVectorsError.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 1159,
|
|
"name": "StorageVectorsError.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 1184,
|
|
"name": "originalError",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 52,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L52"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [1180]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [1184]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 51,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L51"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1158,
|
|
"name": "StorageVectorsError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 794,
|
|
"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": 795,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 256,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L256"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 796,
|
|
"name": "VectorBucketScope",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a helper that automatically scopes all index operations to the provided bucket.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```typescript\nconst bucket = supabase.storage.vectors.from('embeddings-prod')\n```"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 256,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L256"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 797,
|
|
"name": "url",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 798,
|
|
"name": "headers",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 799,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 258,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L258"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 800,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 258,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L258"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 801,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 802,
|
|
"name": "vectorBucketName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 803,
|
|
"name": "fetch",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 804,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 805,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 806,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 807,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 808,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 809,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 810,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 794,
|
|
"name": "VectorBucketScope",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorIndexApi.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorIndexApi.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 812,
|
|
"name": "createIndex",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 293,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L293"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 813,
|
|
"name": "createIndex",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a new vector index in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with empty response on success or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 293,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L293"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 814,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Index configuration (vectorBucketName is automatically set)"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1050,
|
|
"name": "CreateIndexOptions",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "vectorBucketName"
|
|
}
|
|
],
|
|
"name": "Omit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"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": 823,
|
|
"name": "deleteIndex",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 369,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L369"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 824,
|
|
"name": "deleteIndex",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Deletes an index from this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with empty response on success or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 369,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L369"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 825,
|
|
"name": "indexName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Name of the index to delete"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"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": 818,
|
|
"name": "getIndex",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 346,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L346"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 819,
|
|
"name": "getIndex",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Retrieves metadata for a specific index in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with index metadata or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 346,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L346"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 820,
|
|
"name": "indexName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Name of the index to retrieve"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 821,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 822,
|
|
"name": "index",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts",
|
|
"line": 77,
|
|
"character": 27,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts#L77"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1061,
|
|
"name": "VectorIndex",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [822]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts",
|
|
"line": 77,
|
|
"character": 25,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts#L77"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"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": 826,
|
|
"name": "index",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 404,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L404"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 827,
|
|
"name": "index",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Access operations for a specific index within this bucket\nReturns a scoped client for vector data operations\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Index-scoped client with vector data operations"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 404,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L404"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 828,
|
|
"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": 845,
|
|
"name": "VectorIndexScope",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 815,
|
|
"name": "listIndexes",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 319,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L319"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 816,
|
|
"name": "listIndexes",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Lists indexes in this bucket\nConvenience method that automatically includes the bucket name\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing indexes array and pagination token or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 319,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L319"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 817,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Listing options (vectorBucketName is automatically set)"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1098,
|
|
"name": "ListIndexesOptions",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "vectorBucketName"
|
|
}
|
|
],
|
|
"name": "Omit",
|
|
"package": "typescript"
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1103,
|
|
"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": 843,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts",
|
|
"line": 50,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts#L50"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 844,
|
|
"name": "throwOnError",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Enable throwing errors instead of returning them in the response"
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts",
|
|
"line": 50,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts#L50"
|
|
}
|
|
],
|
|
"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": [795]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [812, 823, 818, 826, 815, 843]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Other",
|
|
"children": [843]
|
|
},
|
|
{
|
|
"title": "Vector Buckets",
|
|
"children": [795, 812, 823, 818, 826, 815]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 240,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L240"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "default",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 845,
|
|
"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": 846,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 442,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L442"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 847,
|
|
"name": "VectorIndexScope",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a helper that automatically scopes all vector operations to the provided bucket/index names.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 442,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L442"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 848,
|
|
"name": "url",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 849,
|
|
"name": "headers",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 850,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 444,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L444"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 851,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 444,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L444"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 852,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 853,
|
|
"name": "vectorBucketName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 854,
|
|
"name": "indexName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 855,
|
|
"name": "fetch",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 856,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 857,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 858,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 859,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 860,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 861,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 862,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 845,
|
|
"name": "VectorIndexScope",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorDataApi.constructor"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "VectorDataApi.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 877,
|
|
"name": "deleteVectors",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 607,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L607"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 878,
|
|
"name": "deleteVectors",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Deletes vectors by keys from this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with empty response on success or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 607,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L607"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 879,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Deletion options (bucket and index names automatically set)"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1120,
|
|
"name": "DeleteVectorsOptions",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "vectorBucketName"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "indexName"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Omit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"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": 868,
|
|
"name": "getVectors",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 511,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L511"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 869,
|
|
"name": "getVectors",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Retrieves vectors by keys from this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing vectors array or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 511,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L511"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 870,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector retrieval options (bucket and index names automatically set)"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1112,
|
|
"name": "GetVectorsOptions",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "vectorBucketName"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "indexName"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Omit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1118,
|
|
"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": 871,
|
|
"name": "listVectors",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 541,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L541"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 872,
|
|
"name": "listVectors",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Lists vectors in this index with pagination\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing vectors array and pagination token or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 541,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L541"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 873,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Listing options (bucket and index names automatically set)"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1124,
|
|
"name": "ListVectorsOptions",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "vectorBucketName"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "indexName"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Omit",
|
|
"package": "typescript"
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1133,
|
|
"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": 865,
|
|
"name": "putVectors",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 481,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L481"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 866,
|
|
"name": "putVectors",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Inserts or updates vectors in this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with empty response on success or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 481,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L481"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 867,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector insertion options (bucket and index names automatically set)"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1108,
|
|
"name": "PutVectorsOptions",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "vectorBucketName"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "indexName"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Omit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"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": 874,
|
|
"name": "queryVectors",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 576,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L576"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 875,
|
|
"name": "queryVectors",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Queries for similar vectors in this index\nConvenience method that automatically includes bucket and index names\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing matches array of similar vectors ordered by distance or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 576,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L576"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 876,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Query options (bucket and index names automatically set)"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1136,
|
|
"name": "QueryVectorsOptions",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "vectorBucketName"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "indexName"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Omit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1147,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1144,
|
|
"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": 894,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorDataApi.ts",
|
|
"line": 36,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorDataApi.ts#L36"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 895,
|
|
"name": "throwOnError",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Enable throwing errors instead of returning them in the response"
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorDataApi.ts",
|
|
"line": 36,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorDataApi.ts#L36"
|
|
}
|
|
],
|
|
"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": [846]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [877, 868, 871, 865, 874, 894]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Other",
|
|
"children": [894]
|
|
},
|
|
{
|
|
"title": "Vector Buckets",
|
|
"children": [846, 877, 868, 871, 865, 874]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 424,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L424"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "default",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 635,
|
|
"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": 639,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L42"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 638,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L40"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 636,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L36"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 637,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L38"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "ANALYTICS"
|
|
}
|
|
},
|
|
{
|
|
"id": 640,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L44"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [639, 638, 636, 637, 640]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 34,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L34"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 619,
|
|
"name": "Bucket",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 625,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L16"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 626,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L17"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 624,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L15"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 620,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L11"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 622,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L13"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 623,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L14"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 628,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L19"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 621,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L12"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 618,
|
|
"name": "BucketType",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 627,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L18"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [625, 626, 624, 620, 622, 623, 628, 621, 627]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 10,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L10"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1050,
|
|
"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": 1053,
|
|
"name": "dataType",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts",
|
|
"line": 25,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts#L25"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "float32"
|
|
}
|
|
},
|
|
{
|
|
"id": 1054,
|
|
"name": "dimension",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts",
|
|
"line": 26,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts#L26"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1055,
|
|
"name": "distanceMetric",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts",
|
|
"line": 27,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts#L27"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1087,
|
|
"name": "DistanceMetric",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1052,
|
|
"name": "indexName",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts",
|
|
"line": 24,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts#L24"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1056,
|
|
"name": "metadataConfiguration",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts",
|
|
"line": 28,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts#L28"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1084,
|
|
"name": "MetadataConfiguration",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1051,
|
|
"name": "vectorBucketName",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts",
|
|
"line": 23,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts#L23"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1053, 1054, 1055, 1052, 1056, 1051]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts",
|
|
"line": 22,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/VectorIndexApi.ts#L22"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1120,
|
|
"name": "DeleteVectorsOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for batch deleting vectors"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1122,
|
|
"name": "indexName",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Name of the index"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 196,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L196"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1123,
|
|
"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/vectors/types.ts",
|
|
"line": 197,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L197"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1121,
|
|
"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/vectors/types.ts",
|
|
"line": 195,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L195"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1122, 1123, 1121]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 194,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L194"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 675,
|
|
"name": "DestinationOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 676,
|
|
"name": "destinationBucket",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 112,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L112"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [676]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 111,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L111"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1081,
|
|
"name": "EncryptionConfiguration",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Configuration for encryption at rest"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1082,
|
|
"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/vectors/types.ts",
|
|
"line": 9,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L9"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1083,
|
|
"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/vectors/types.ts",
|
|
"line": 10,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L10"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1082, 1083]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 8,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L8"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1153,
|
|
"name": "ErrorResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Standard response wrapper for failed operations"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1154,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Null on error"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 293,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L293"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 1155,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "StorageVectorsError with details"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 294,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L294"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1158,
|
|
"name": "StorageVectorsError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1154, 1155]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 292,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L292"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1197,
|
|
"name": "FetchOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for fetch requests"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1198,
|
|
"name": "headers",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Custom HTTP headers"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/fetch.ts",
|
|
"line": 13,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/fetch.ts#L13"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1199,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/fetch.ts",
|
|
"line": 13,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/fetch.ts#L13"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 1200,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/fetch.ts",
|
|
"line": 14,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/fetch.ts#L14"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1201,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1202,
|
|
"name": "noResolveJson",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "If true, return raw Response instead of parsing JSON"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/fetch.ts",
|
|
"line": 16,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/fetch.ts#L16"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1198, 1202]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/fetch.ts",
|
|
"line": 12,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/fetch.ts#L12"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 705,
|
|
"name": "FetchParameters",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 706,
|
|
"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": 204,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L204"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "AbortSignal"
|
|
},
|
|
"name": "AbortSignal",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [706]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 200,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L200"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 641,
|
|
"name": "FileObject",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 643,
|
|
"name": "bucket_id",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 49,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L49"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 650,
|
|
"name": "buckets",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 57,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L57"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 619,
|
|
"name": "Bucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 647,
|
|
"name": "created_at",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 53,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L53"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 645,
|
|
"name": "id",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 51,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L51"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 648,
|
|
"name": "last_accessed_at",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@deprecated",
|
|
"content": []
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 55,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L55"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 649,
|
|
"name": "metadata",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 56,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L56"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Record"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 642,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 48,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L48"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 644,
|
|
"name": "owner",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 50,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L50"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 646,
|
|
"name": "updated_at",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 52,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L52"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [643, 650, 647, 645, 648, 649, 642, 644, 646]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 47,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L47"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 651,
|
|
"name": "FileObjectV2",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 655,
|
|
"name": "bucket_id",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 64,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L64"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 660,
|
|
"name": "cache_control",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 70,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L70"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 661,
|
|
"name": "content_type",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 71,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L71"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 657,
|
|
"name": "created_at",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 66,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L66"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 662,
|
|
"name": "etag",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 72,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L72"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 652,
|
|
"name": "id",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 61,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L61"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 658,
|
|
"name": "last_accessed_at",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@deprecated",
|
|
"content": []
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 68,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L68"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 663,
|
|
"name": "last_modified",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 73,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L73"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 664,
|
|
"name": "metadata",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 74,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L74"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Record"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 654,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 63,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L63"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 659,
|
|
"name": "size",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 69,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L69"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 656,
|
|
"name": "updated_at",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 65,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L65"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 653,
|
|
"name": "version",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 62,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L62"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [655, 660, 661, 657, 662, 652, 658, 663, 664, 654, 659, 656, 653]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 60,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L60"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 668,
|
|
"name": "FileOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 669,
|
|
"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": 86,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L86"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 670,
|
|
"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": 90,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L90"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 672,
|
|
"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": 98,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L98"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 674,
|
|
"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": 108,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L108"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Record"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 673,
|
|
"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": 103,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L103"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Record"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 671,
|
|
"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": 94,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L94"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [669, 670, 672, 674, 673, 671]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 82,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L82"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1112,
|
|
"name": "GetVectorsOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for batch reading vectors"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1114,
|
|
"name": "indexName",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Name of the index"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 162,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L162"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1115,
|
|
"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/vectors/types.ts",
|
|
"line": 163,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L163"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1116,
|
|
"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/vectors/types.ts",
|
|
"line": 164,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L164"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1117,
|
|
"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/vectors/types.ts",
|
|
"line": 165,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L165"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1113,
|
|
"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/vectors/types.ts",
|
|
"line": 161,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L161"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1114, 1115, 1116, 1117, 1113]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 160,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L160"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1118,
|
|
"name": "GetVectorsResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Response from getting vectors"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1119,
|
|
"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/vectors/types.ts",
|
|
"line": 173,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L173"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1076,
|
|
"name": "VectorMatch",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1119]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 172,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L172"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 629,
|
|
"name": "ListBucketOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 630,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L23"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 631,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L24"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 634,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L27"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 632,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/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": 633,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/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": [630, 631, 634, 632, 633]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 22,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L22"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1098,
|
|
"name": "ListIndexesOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for listing indexes within a bucket"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1101,
|
|
"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/vectors/types.ts",
|
|
"line": 138,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L138"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1102,
|
|
"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/vectors/types.ts",
|
|
"line": 139,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L139"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1100,
|
|
"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/vectors/types.ts",
|
|
"line": 137,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L137"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1099,
|
|
"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/vectors/types.ts",
|
|
"line": 136,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L136"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1101, 1102, 1100, 1099]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 135,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L135"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1103,
|
|
"name": "ListIndexesResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Response from listing indexes"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1104,
|
|
"name": "indexes",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Array of index names"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 148,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L148"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1105,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1106,
|
|
"name": "indexName",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 148,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L148"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1106]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 148,
|
|
"character": 11,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L148"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1107,
|
|
"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/vectors/types.ts",
|
|
"line": 149,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L149"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1104, 1107]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 147,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L147"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1089,
|
|
"name": "ListVectorBucketsOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for fetching vector buckets"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1091,
|
|
"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/vectors/types.ts",
|
|
"line": 114,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L114"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1092,
|
|
"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/vectors/types.ts",
|
|
"line": 115,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L115"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1090,
|
|
"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/vectors/types.ts",
|
|
"line": 113,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L113"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1091, 1092, 1090]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 112,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L112"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1093,
|
|
"name": "ListVectorBucketsResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Response from listing vector buckets"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1097,
|
|
"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/vectors/types.ts",
|
|
"line": 125,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L125"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1094,
|
|
"name": "vectorBuckets",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Array of bucket names"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 124,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L124"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1095,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1096,
|
|
"name": "vectorBucketName",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 124,
|
|
"character": 19,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L124"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1096]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 124,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L124"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1097, 1094]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 123,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L123"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1124,
|
|
"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": 1126,
|
|
"name": "indexName",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Name of the index"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 214,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L214"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1127,
|
|
"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/vectors/types.ts",
|
|
"line": 215,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L215"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1128,
|
|
"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/vectors/types.ts",
|
|
"line": 216,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L216"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1129,
|
|
"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/vectors/types.ts",
|
|
"line": 217,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L217"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1130,
|
|
"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/vectors/types.ts",
|
|
"line": 218,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L218"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1131,
|
|
"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/vectors/types.ts",
|
|
"line": 219,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L219"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1132,
|
|
"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/vectors/types.ts",
|
|
"line": 220,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L220"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1125,
|
|
"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/vectors/types.ts",
|
|
"line": 213,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L213"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1126, 1127, 1128, 1129, 1130, 1131, 1132, 1125]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 212,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L212"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1133,
|
|
"name": "ListVectorsResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Response from listing vectors"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1135,
|
|
"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/vectors/types.ts",
|
|
"line": 230,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L230"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1134,
|
|
"name": "vectors",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Array of vector objects"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 229,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L229"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1076,
|
|
"name": "VectorMatch",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1135, 1134]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 228,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L228"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 707,
|
|
"name": "Metadata",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 708,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 209,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L209"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [708]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 208,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L208"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1084,
|
|
"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": 1085,
|
|
"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/vectors/types.ts",
|
|
"line": 31,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L31"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1085]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 30,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L30"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1108,
|
|
"name": "PutVectorsOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for batch inserting/updating vectors"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1110,
|
|
"name": "indexName",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Name of the index"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 184,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L184"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1109,
|
|
"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/vectors/types.ts",
|
|
"line": 183,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L183"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1111,
|
|
"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/vectors/types.ts",
|
|
"line": 185,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L185"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1072,
|
|
"name": "VectorObject",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1110, 1109, 1111]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 182,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L182"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1136,
|
|
"name": "QueryVectorsOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Options for querying similar vectors (ANN search)"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1141,
|
|
"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/vectors/types.ts",
|
|
"line": 254,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L254"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1088,
|
|
"name": "VectorFilter",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1138,
|
|
"name": "indexName",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Name of the index"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 251,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L251"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1139,
|
|
"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/vectors/types.ts",
|
|
"line": 252,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L252"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1069,
|
|
"name": "VectorData",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1142,
|
|
"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/vectors/types.ts",
|
|
"line": 255,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L255"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1143,
|
|
"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/vectors/types.ts",
|
|
"line": 256,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L256"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 1140,
|
|
"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/vectors/types.ts",
|
|
"line": 253,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L253"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1137,
|
|
"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/vectors/types.ts",
|
|
"line": 250,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L250"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1141, 1138, 1139, 1142, 1143, 1140, 1137]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 249,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L249"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1144,
|
|
"name": "QueryVectorsResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Response from vector similarity query"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1146,
|
|
"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/vectors/types.ts",
|
|
"line": 266,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L266"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1087,
|
|
"name": "DistanceMetric",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1145,
|
|
"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/vectors/types.ts",
|
|
"line": 265,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L265"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 1076,
|
|
"name": "VectorMatch",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1146, 1145]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 264,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L264"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 677,
|
|
"name": "SearchOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 678,
|
|
"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": 120,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L120"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 679,
|
|
"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": 125,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L125"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 681,
|
|
"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": 135,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L135"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 680,
|
|
"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": 130,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L130"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 665,
|
|
"name": "SortBy",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [678, 679, 681, 680]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 115,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L115"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 691,
|
|
"name": "SearchV2Object",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 696,
|
|
"name": "created_at",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 183,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L183"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 692,
|
|
"name": "id",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 179,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L179"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 693,
|
|
"name": "key",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 180,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L180"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 698,
|
|
"name": "last_accessed_at",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@deprecated",
|
|
"content": []
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 188,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L188"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 697,
|
|
"name": "metadata",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 184,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L184"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Record"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 694,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 181,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L181"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 695,
|
|
"name": "updated_at",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 182,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L182"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [696, 692, 693, 698, 697, 694, 695]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 178,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L178"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 685,
|
|
"name": "SearchV2Options",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 688,
|
|
"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": 158,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L158"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 686,
|
|
"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": 148,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L148"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 687,
|
|
"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": 153,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L153"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 690,
|
|
"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": 175,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L175"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 682,
|
|
"name": "SortByV2",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 689,
|
|
"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": 169,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L169"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [688, 686, 687, 690, 689]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 143,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L143"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 700,
|
|
"name": "SearchV2Result",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 702,
|
|
"name": "folders",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 195,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L195"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 699,
|
|
"name": "SearchV2Folder",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 701,
|
|
"name": "hasNext",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 194,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L194"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 704,
|
|
"name": "nextCursor",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 197,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L197"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 703,
|
|
"name": "objects",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 196,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L196"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 691,
|
|
"name": "SearchV2Object",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [702, 701, 704, 703]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 193,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L193"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 665,
|
|
"name": "SortBy",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 666,
|
|
"name": "column",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 78,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L78"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 667,
|
|
"name": "order",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 79,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L79"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [666, 667]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 77,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L77"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 682,
|
|
"name": "SortByV2",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 683,
|
|
"name": "column",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 139,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L139"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "name"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "created_at"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "updated_at"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 684,
|
|
"name": "order",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 140,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L140"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "asc"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "desc"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [683, 684]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 138,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L138"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 615,
|
|
"name": "StorageClientOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 616,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L8"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [616]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/StorageClient.ts",
|
|
"line": 7,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/StorageClient.ts#L7"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 896,
|
|
"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": 901,
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 35,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L35"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 902,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 903,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 904,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 905,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 906,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 907,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 908,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 897,
|
|
"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/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 30,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L30"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 898,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 30,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L30"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 899,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 30,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L30"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 900,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [901, 897]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts",
|
|
"line": 26,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/StorageVectorsClient.ts#L26"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1149,
|
|
"name": "SuccessResponse",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Standard response wrapper for successful operations"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1150,
|
|
"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/vectors/types.ts",
|
|
"line": 283,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L283"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1152,
|
|
"name": "T",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "SuccessResponse.T",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 1151,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Null on success"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 284,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L284"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1150, 1151]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 282,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L282"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 1152,
|
|
"name": "T",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 709,
|
|
"name": "TransformOptions",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 714,
|
|
"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": 240,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L240"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "origin"
|
|
}
|
|
},
|
|
{
|
|
"id": 711,
|
|
"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": 220,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L220"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 713,
|
|
"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": 233,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L233"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 712,
|
|
"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": 227,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L227"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "cover"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "contain"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "fill"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 710,
|
|
"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": 216,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L216"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [714, 711, 713, 712, 710]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 212,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L212"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1057,
|
|
"name": "VectorBucket",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector bucket metadata"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1059,
|
|
"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/vectors/types.ts",
|
|
"line": 21,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L21"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1060,
|
|
"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/vectors/types.ts",
|
|
"line": 22,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L22"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1081,
|
|
"name": "EncryptionConfiguration",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1058,
|
|
"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/vectors/types.ts",
|
|
"line": 20,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L20"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1059, 1060, 1058]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 19,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L19"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1069,
|
|
"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": 1070,
|
|
"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/vectors/types.ts",
|
|
"line": 71,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L71"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1070]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 70,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L70"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1156,
|
|
"name": "VectorFetchParameters",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Fetch-specific parameters like abort signals"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1157,
|
|
"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/vectors/types.ts",
|
|
"line": 274,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L274"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "AbortSignal"
|
|
},
|
|
"name": "AbortSignal",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1157]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 273,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L273"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1061,
|
|
"name": "VectorIndex",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector index configuration and metadata"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1068,
|
|
"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/vectors/types.ts",
|
|
"line": 62,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L62"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1064,
|
|
"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/vectors/types.ts",
|
|
"line": 58,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L58"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "float32"
|
|
}
|
|
},
|
|
{
|
|
"id": 1065,
|
|
"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/vectors/types.ts",
|
|
"line": 59,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L59"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1066,
|
|
"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/vectors/types.ts",
|
|
"line": 60,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L60"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1087,
|
|
"name": "DistanceMetric",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1062,
|
|
"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/vectors/types.ts",
|
|
"line": 56,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L56"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1067,
|
|
"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/vectors/types.ts",
|
|
"line": 61,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L61"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1084,
|
|
"name": "MetadataConfiguration",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1063,
|
|
"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/vectors/types.ts",
|
|
"line": 57,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L57"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1068, 1064, 1065, 1066, 1062, 1067, 1063]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 55,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L55"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1076,
|
|
"name": "VectorMatch",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector object returned from queries with optional distance"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1078,
|
|
"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/vectors/types.ts",
|
|
"line": 101,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L101"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1069,
|
|
"name": "VectorData",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1080,
|
|
"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/vectors/types.ts",
|
|
"line": 103,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L103"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 1077,
|
|
"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/vectors/types.ts",
|
|
"line": 100,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L100"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1079,
|
|
"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/vectors/types.ts",
|
|
"line": 102,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L102"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1071,
|
|
"name": "VectorMetadata",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1078, 1080, 1077, 1079]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 99,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L99"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1072,
|
|
"name": "VectorObject",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Single vector object for insertion/update"
|
|
}
|
|
]
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 1074,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector embedding data"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 88,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L88"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1069,
|
|
"name": "VectorData",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 1073,
|
|
"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/vectors/types.ts",
|
|
"line": 87,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L87"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 1075,
|
|
"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/vectors/types.ts",
|
|
"line": 89,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L89"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 1071,
|
|
"name": "VectorMetadata",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1074, 1073, 1075]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/types.ts",
|
|
"line": 86,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L86"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1147,
|
|
"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/vectors/types.ts",
|
|
"line": 301,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L301"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 1148,
|
|
"name": "T",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1149,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 1148,
|
|
"name": "T",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "SuccessResponse",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 1153,
|
|
"name": "ErrorResponse",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 618,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L8"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "STANDARD"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "ANALYTICS"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 715,
|
|
"name": "Camelize",
|
|
"variant": "declaration",
|
|
"kind": 2097152,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 247,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L247"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 716,
|
|
"name": "T",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "mapped",
|
|
"parameter": "K",
|
|
"parameterType": {
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"target": 716,
|
|
"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": 716,
|
|
"name": "T",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"nameType": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "CamelCase"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Extract"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "K"
|
|
},
|
|
"name": "K",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"name": "Extract",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "CamelCase",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1087,
|
|
"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/vectors/types.ts",
|
|
"line": 43,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L43"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "cosine"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "euclidean"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "dotproduct"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 717,
|
|
"name": "DownloadResult",
|
|
"variant": "declaration",
|
|
"kind": 2097152,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 251,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L251"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 724,
|
|
"name": "T",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 718,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 719,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 253,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L253"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 724,
|
|
"name": "T",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 720,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 254,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L254"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [719, 720]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 252,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L252"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 721,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 722,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 257,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L257"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 723,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 258,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L258"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [722, 723]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 256,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L256"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1196,
|
|
"name": "Fetch",
|
|
"variant": "declaration",
|
|
"kind": 2097152,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/fetch.ts",
|
|
"line": 5,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/fetch.ts#L5"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "query",
|
|
"queryType": {
|
|
"type": "reference",
|
|
"target": 57,
|
|
"name": "fetch",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1203,
|
|
"name": "RequestMethodType",
|
|
"variant": "declaration",
|
|
"kind": 2097152,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "HTTP methods supported by the API"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/fetch.ts",
|
|
"line": 22,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/fetch.ts#L22"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "GET"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "POST"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "PUT"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "DELETE"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 699,
|
|
"name": "SearchV2Folder",
|
|
"variant": "declaration",
|
|
"kind": 2097152,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/types.ts",
|
|
"line": 191,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/types.ts#L191"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Omit"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 691,
|
|
"name": "SearchV2Object",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "id"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "metadata"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "last_accessed_at"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Omit",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 1086,
|
|
"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/vectors/types.ts",
|
|
"line": 38,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L38"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "float32"
|
|
}
|
|
},
|
|
{
|
|
"id": 1088,
|
|
"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/vectors/types.ts",
|
|
"line": 237,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L237"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Record"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 1071,
|
|
"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/vectors/types.ts",
|
|
"line": 78,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/types.ts#L78"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Record"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 1227,
|
|
"name": "isPlainObject",
|
|
"variant": "declaration",
|
|
"kind": 64,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Determine if input is a plain object\nAn object is plain if it's created by either {}, new Object(), or Object.create(null)"
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@source",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "https://github.com/sindresorhus/is-plain-obj"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 35,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L35"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1228,
|
|
"name": "isPlainObject",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "True if value is a plain object"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 35,
|
|
"character": 29,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L35"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1229,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Value to check"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "object"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 725,
|
|
"name": "isStorageError",
|
|
"variant": "declaration",
|
|
"kind": 64,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 10,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L10"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 726,
|
|
"name": "isStorageError",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/errors.ts",
|
|
"line": 10,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/errors.ts#L10"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 727,
|
|
"name": "error",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "predicate",
|
|
"name": "error",
|
|
"asserts": false,
|
|
"targetType": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1193,
|
|
"name": "isStorageVectorsError",
|
|
"variant": "declaration",
|
|
"kind": 64,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/errors.ts",
|
|
"line": 18,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L18"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1194,
|
|
"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/vectors/errors.ts",
|
|
"line": 18,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/errors.ts#L18"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1195,
|
|
"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": 1158,
|
|
"name": "StorageVectorsError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1230,
|
|
"name": "normalizeToFloat32",
|
|
"variant": "declaration",
|
|
"kind": 64,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Normalizes a number array to float32 format\nEnsures all vector values are valid 32-bit floats"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 57,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L57"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1231,
|
|
"name": "normalizeToFloat32",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Normalized float32 array"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 57,
|
|
"character": 34,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L57"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1232,
|
|
"name": "values",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Array of numbers to normalize"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1204,
|
|
"name": "resolveFetch",
|
|
"variant": "declaration",
|
|
"kind": 64,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Resolves the fetch implementation to use\nUses custom fetch if provided, otherwise uses native fetch"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 10,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L10"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1205,
|
|
"name": "resolveFetch",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Resolved fetch function"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 10,
|
|
"character": 28,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L10"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1206,
|
|
"name": "customFetch",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Optional custom fetch implementation"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1207,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1208,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1209,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1210,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 1211,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1212,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1213,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1214,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1215,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1216,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1217,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 1218,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1219,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1220,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1221,
|
|
"name": "resolveResponse",
|
|
"variant": "declaration",
|
|
"kind": 64,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Resolves the Response constructor to use\nReturns native Response constructor"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 23,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L23"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1222,
|
|
"name": "resolveResponse",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Response constructor"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 23,
|
|
"character": 31,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L23"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1223,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 19898,
|
|
"character": 22
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1224,
|
|
"name": "resolveResponse",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 19900,
|
|
"character": 4
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1225,
|
|
"name": "body",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "BodyInit"
|
|
},
|
|
"name": "BodyInit",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 1226,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "ResponseInit"
|
|
},
|
|
"name": "ResponseInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 1233,
|
|
"name": "validateVectorDimension",
|
|
"variant": "declaration",
|
|
"kind": 64,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Validates vector dimensions match expected dimension\nThrows error if dimensions don't match"
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@throws",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Error if dimensions don't match"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 70,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L70"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 1234,
|
|
"name": "validateVectorDimension",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 70,
|
|
"character": 39,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L70"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 1235,
|
|
"name": "vector",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Vector data to validate"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 1236,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 1237,
|
|
"name": "float32",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 71,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L71"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [1237]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/lib/vectors/helpers.ts",
|
|
"line": 71,
|
|
"character": 10,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/lib/vectors/helpers.ts#L71"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 1238,
|
|
"name": "expectedDimension",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Expected vector dimension"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 617,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/index.ts#L3"
|
|
}
|
|
],
|
|
"target": 48
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Enumerations",
|
|
"children": [1186]
|
|
},
|
|
{
|
|
"title": "Classes",
|
|
"children": [733, 504, 728, 749, 1163, 756, 1158, 1179, 794, 845]
|
|
},
|
|
{
|
|
"title": "Interfaces",
|
|
"children": [
|
|
635, 619, 1050, 1120, 675, 1081, 1153, 1197, 705, 641, 651, 668, 1112, 1118, 629, 1098,
|
|
1103, 1089, 1093, 1124, 1133, 707, 1084, 1108, 1136, 1144, 677, 691, 685, 700, 665, 682,
|
|
615, 896, 1149, 709, 1057, 1069, 1156, 1061, 1076, 1072
|
|
]
|
|
},
|
|
{
|
|
"title": "Type Aliases",
|
|
"children": [1147, 618, 715, 1087, 717, 1196, 1203, 699, 1086, 1088, 1071]
|
|
},
|
|
{
|
|
"title": "Functions",
|
|
"children": [1227, 725, 1193, 1230, 1204, 1221, 1233]
|
|
},
|
|
{
|
|
"title": "References",
|
|
"children": [617]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/index.ts",
|
|
"line": 1,
|
|
"character": 0,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L10"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 9,
|
|
"name": "shouldThrowOnError",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 3,
|
|
"name": "BlobDownloadBuilder",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 45,
|
|
"name": "[toStringTag]",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isReadonly": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts",
|
|
"line": 6,
|
|
"character": 11,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L14"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 479,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L26"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 35,
|
|
"name": "reason",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 31,
|
|
"name": "TResult",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "PromiseLike"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 31,
|
|
"name": "TResult",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 717,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Blob"
|
|
},
|
|
"name": "Blob",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "DownloadResult",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 31,
|
|
"name": "TResult",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Promise.catch"
|
|
}
|
|
}
|
|
],
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Promise.catch"
|
|
}
|
|
},
|
|
{
|
|
"id": 36,
|
|
"name": "finally",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts",
|
|
"line": 31,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L31"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "void"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 717,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Blob"
|
|
},
|
|
"name": "Blob",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "DownloadResult",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Promise.finally"
|
|
}
|
|
}
|
|
],
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Promise.finally"
|
|
}
|
|
},
|
|
{
|
|
"id": 17,
|
|
"name": "then",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts",
|
|
"line": 18,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L18"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 19,
|
|
"name": "TResult1",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"target": 717,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Blob"
|
|
},
|
|
"name": "Blob",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "DownloadResult",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 20,
|
|
"name": "TResult2",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 21,
|
|
"name": "onfulfilled",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The callback to execute when the Promise is resolved."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 22,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts",
|
|
"line": 19,
|
|
"character": 19,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L19"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 24,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 717,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Blob"
|
|
},
|
|
"name": "Blob",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "DownloadResult",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 19,
|
|
"name": "TResult1",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "PromiseLike"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 19,
|
|
"name": "TResult1",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 25,
|
|
"name": "onrejected",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The callback to execute when the Promise is rejected."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 26,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts",
|
|
"line": 20,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L20"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 28,
|
|
"name": "reason",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 20,
|
|
"name": "TResult2",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "PromiseLike"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 20,
|
|
"name": "TResult2",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 19,
|
|
"name": "TResult1",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 20,
|
|
"name": "TResult2",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Promise.then"
|
|
}
|
|
}
|
|
],
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "Promise.then"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [4]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [45]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [15, 29, 36, 17]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts",
|
|
"line": 5,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/BlobDownloadBuilder.ts#L5"
|
|
}
|
|
],
|
|
"implementedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 717,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Blob"
|
|
},
|
|
"name": "Blob",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "DownloadResult",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"children": [3]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/BlobDownloadBuilder.ts",
|
|
"line": 1,
|
|
"character": 0,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/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": 43,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L43"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 50,
|
|
"name": "default",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a new StorageAnalyticsClient instance\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Analytics Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```typescript\nconst client = new StorageAnalyticsClient(url, headers)\n```"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 43,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L43"
|
|
}
|
|
],
|
|
"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": 43,
|
|
"character": 36,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L43"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 54,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 43,
|
|
"character": 38,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L43"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 55,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 56,
|
|
"name": "fetch",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Optional custom fetch implementation"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 57,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 58,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 59,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 60,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 61,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 62,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 63,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 48,
|
|
"name": "StorageAnalyticsClient",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 80,
|
|
"name": "createBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 99,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L99"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 81,
|
|
"name": "createBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a new analytics bucket using Iceberg tables\nAnalytics buckets are optimized for analytical queries and data processing\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Analytics Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing newly created analytics bucket or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Create analytics bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .createBucket('analytics-data')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"name\": \"analytics-data\",\n \"type\": \"ANALYTICS\",\n \"format\": \"iceberg\",\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 99,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L99"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 82,
|
|
"name": "name",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "A unique name for the bucket you are creating"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 83,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 84,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L101"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 635,
|
|
"name": "AnalyticBucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 85,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L102"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [84, 85]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 100,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L100"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 86,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 87,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 105,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L105"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 88,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 106,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L106"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [87, 88]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 104,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L104"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 104,
|
|
"name": "deleteBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 244,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L244"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 105,
|
|
"name": "deleteBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Deletes an existing analytics bucket\nA bucket can't be deleted with existing objects inside it\nYou must first empty the bucket before deletion\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Analytics Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing success message or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Delete analytics bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .deleteBucket('analytics-data')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 244,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L244"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 106,
|
|
"name": "bucketName",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The unique identifier of the bucket you would like to delete"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 107,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 108,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 246,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L246"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 109,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 110,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 246,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L246"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [110]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 246,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L246"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 111,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 247,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L247"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [108, 111]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 245,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L245"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 112,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 113,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 250,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L250"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 114,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 251,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L251"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [113, 114]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 249,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L249"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 115,
|
|
"name": "from",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 397,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L397"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 116,
|
|
"name": "from",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Get an Iceberg REST Catalog client configured for a specific analytics bucket\nUse this to perform advanced table and namespace operations within the bucket\nThe returned client provides full access to the Apache Iceberg REST Catalog API\nwith the Supabase "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`{ data, error }`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " pattern for consistent error handling on all operations.\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Analytics Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The wrapped Iceberg catalog client"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@throws",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "If the bucket name is invalid"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Get catalog and create table",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\n// First, create an analytics bucket\nconst { data: bucket, error: bucketError } = await supabase\n .storage\n .analytics\n .createBucket('analytics-data')\n\n// Get the Iceberg catalog for that bucket\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// Create a namespace\nconst { error: nsError } = await catalog.createNamespace({ namespace: ['default'] })\n\n// Create a table with schema\nconst { data: tableMetadata, error: tableError } = await catalog.createTable(\n { namespace: ['default'] },\n {\n name: 'events',\n schema: {\n type: 'struct',\n fields: [\n { id: 1, name: 'id', type: 'long', required: true },\n { id: 2, name: 'timestamp', type: 'timestamp', required: true },\n { id: 3, name: 'user_id', type: 'string', required: false }\n ],\n 'schema-id': 0,\n 'identifier-field-ids': [1]\n },\n 'partition-spec': {\n 'spec-id': 0,\n fields: []\n },\n 'write-order': {\n 'order-id': 0,\n fields: []\n },\n properties: {\n 'write.format.default': 'parquet'\n }\n }\n)\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "List tables in namespace",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// List all tables in the default namespace\nconst { data: tables, error: listError } = await catalog.listTables({ namespace: ['default'] })\nif (listError) {\n if (listError.isNotFound()) {\n console.log('Namespace not found')\n }\n return\n}\nconsole.log(tables) // [{ namespace: ['default'], name: 'events' }]\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Working with namespaces",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// List all namespaces\nconst { data: namespaces } = await catalog.listNamespaces()\n\n// Create namespace with properties\nawait catalog.createNamespace(\n { namespace: ['production'] },\n { properties: { owner: 'data-team', env: 'prod' } }\n)\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Cleanup operations",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst catalog = supabase.storage.analytics.from('analytics-data')\n\n// Drop table with purge option (removes all data)\nconst { error: dropError } = await catalog.dropTable(\n { namespace: ['default'], name: 'events' },\n { purge: true }\n)\n\nif (dropError?.isNotFound()) {\n console.log('Table does not exist')\n}\n\n// Drop namespace (must be empty)\nawait catalog.dropNamespace({ namespace: ['default'] })\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@remarks",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "This method provides a bridge between Supabase's bucket management and the standard\nApache Iceberg REST Catalog API. The bucket name maps to the Iceberg warehouse parameter.\nAll authentication and configuration is handled automatically using your Supabase credentials.\n\n**Error Handling**: Invalid bucket names throw immediately. All catalog\noperations return "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`{ data, error }`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " where errors are "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`IcebergError`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " instances from iceberg-js.\nUse helper methods like "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`error.isNotFound()`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " or check "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`error.status`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " for specific error handling.\nUse "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`.throwOnError()`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " on the analytics client if you prefer exceptions for catalog operations.\n\n**Cleanup Operations**: When using "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dropTable`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ", the "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`purge: true`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " option permanently\ndeletes all table data. Without it, the table is marked as deleted but data remains.\n\n**Library Dependency**: The returned catalog wraps "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`IcebergRestCatalog`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " from iceberg-js.\nFor complete API documentation and advanced usage, refer to the\n[iceberg-js documentation](https://supabase.github.io/iceberg-js/)."
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 397,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L397"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 117,
|
|
"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": 89,
|
|
"name": "listBuckets",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 170,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L170"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 90,
|
|
"name": "listBuckets",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Retrieves the details of all Analytics Storage buckets within an existing project\nOnly returns buckets of type 'ANALYTICS'\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Analytics Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing array of analytics buckets or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "List analytics buckets",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .analytics\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc'\n })\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": [\n {\n \"name\": \"analytics-data\",\n \"type\": \"ANALYTICS\",\n \"format\": \"iceberg\",\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n }\n ],\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 170,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L170"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 91,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Query parameters for listing buckets"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 92,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 93,
|
|
"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": 171,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L171"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 94,
|
|
"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": 172,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L172"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 97,
|
|
"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": 175,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L175"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 95,
|
|
"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": 173,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L173"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "name"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "created_at"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "updated_at"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 96,
|
|
"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": 174,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L174"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "asc"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "desc"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [93, 94, 97, 95, 96]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 170,
|
|
"character": 30,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L170"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 98,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 99,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 178,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L178"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 635,
|
|
"name": "AnalyticBucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 100,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 179,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L179"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [99, 100]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 177,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L177"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 101,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 102,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 182,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L182"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 103,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 183,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L183"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [102, 103]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 181,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L181"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 78,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 60,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L60"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 79,
|
|
"name": "throwOnError",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Enable throwing errors instead of returning them in the response\nWhen enabled, failed operations will throw instead of returning { data: null, error }\n\n**Public alpha:** This API is part of a public alpha release and may not be available to your account type."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Analytics Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "This instance for method chaining"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@alpha"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 60,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L60"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [49]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [80, 104, 115, 89, 78]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Analytics Buckets",
|
|
"children": [49, 80, 104, 115, 89, 78]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 20,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L20"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 47,
|
|
"name": "WrappedIcebergRestCatalog",
|
|
"variant": "declaration",
|
|
"kind": 2097152,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 12,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L12"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "mapped",
|
|
"parameter": "K",
|
|
"parameterType": {
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/iceberg-js/dist/index.d.ts",
|
|
"qualifiedName": "IcebergRestCatalog"
|
|
},
|
|
"name": "IcebergRestCatalog",
|
|
"package": "iceberg-js"
|
|
}
|
|
},
|
|
"templateType": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "WrapAsyncMethod"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "K"
|
|
},
|
|
"name": "K",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/iceberg-js/dist/index.d.ts",
|
|
"qualifiedName": "IcebergRestCatalog"
|
|
},
|
|
"name": "IcebergRestCatalog",
|
|
"package": "iceberg-js"
|
|
}
|
|
}
|
|
],
|
|
"name": "WrapAsyncMethod",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"children": [48]
|
|
},
|
|
{
|
|
"title": "Type Aliases",
|
|
"children": [47]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageAnalyticsClient.ts",
|
|
"line": 1,
|
|
"character": 0,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageAnalyticsClient.ts#L1"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 118,
|
|
"name": "packages/StorageBucketApi",
|
|
"variant": "declaration",
|
|
"kind": 2,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 119,
|
|
"name": "default",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 120,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 14,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L14"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 121,
|
|
"name": "default",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 14,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L14"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 122,
|
|
"name": "url",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 123,
|
|
"name": "headers",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 124,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 16,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L16"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 125,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 16,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L16"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 126,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 127,
|
|
"name": "fetch",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 128,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 129,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 130,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 131,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 132,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 133,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 134,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 135,
|
|
"name": "opts",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 615,
|
|
"name": "StorageClientOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 119,
|
|
"name": "StorageBucketApi",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 170,
|
|
"name": "createBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 201,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 171,
|
|
"name": "createBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a new Storage bucket"
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing newly created bucket name or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Create bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .createBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"name\": \"avatars\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 201,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L201"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 172,
|
|
"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": 173,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 174,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 177,
|
|
"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": 206,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L206"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 176,
|
|
"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": 205,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L205"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 175,
|
|
"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": 204,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L204"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 178,
|
|
"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": 207,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L207"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 618,
|
|
"name": "BucketType",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [177, 176, 175, 178]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 203,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L203"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 179,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 180,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 213,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L213"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Pick"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 619,
|
|
"name": "Bucket",
|
|
"package": "@supabase/storage-js"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "name"
|
|
}
|
|
],
|
|
"name": "Pick",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 181,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 214,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L214"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [180, 181]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 212,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L212"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 182,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 183,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 217,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L217"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 184,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 218,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L218"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [183, 184]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 216,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L216"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 212,
|
|
"name": "deleteBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 405,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L405"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 213,
|
|
"name": "deleteBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`empty()`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " the bucket."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with success message or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Delete bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .deleteBucket('avatars')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"message\": \"Successfully deleted\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 405,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L405"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 214,
|
|
"name": "id",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The unique identifier of the bucket you would like to delete."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 215,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 216,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 407,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L407"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 217,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 218,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 407,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L407"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [218]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 407,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L407"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 219,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 408,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L408"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [216, 219]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 406,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L406"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 220,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 221,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 411,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L411"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 222,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 412,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L412"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [221, 222]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 410,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L410"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 201,
|
|
"name": "emptyBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 350,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L350"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 202,
|
|
"name": "emptyBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Removes all objects inside a single bucket."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with success message or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Empty bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .emptyBucket('avatars')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"message\": \"Successfully emptied\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 350,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L350"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 203,
|
|
"name": "id",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The unique identifier of the bucket you would like to empty."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 204,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 205,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 352,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L352"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 206,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 207,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 352,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L352"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [207]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 352,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L352"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 208,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 353,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L353"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [205, 208]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 351,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L351"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 209,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 210,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 356,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L356"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 211,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 357,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L357"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [210, 211]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 355,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L355"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 161,
|
|
"name": "getBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 139,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L139"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 162,
|
|
"name": "getBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Retrieves the details of an existing Storage bucket."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing bucket details or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Get bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .getBucket('avatars')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"id\": \"avatars\",\n \"name\": \"avatars\",\n \"owner\": \"\",\n \"public\": false,\n \"file_size_limit\": 1024,\n \"allowed_mime_types\": [\n \"image/png\"\n ],\n \"created_at\": \"2024-05-22T22:26:05.100Z\",\n \"updated_at\": \"2024-05-22T22:26:05.100Z\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 139,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L139"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 163,
|
|
"name": "id",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The unique identifier of the bucket you would like to retrieve."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 164,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 165,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 141,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L141"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 619,
|
|
"name": "Bucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 166,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 142,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L142"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [165, 166]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 140,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L140"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 167,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 168,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 145,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L145"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 169,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 146,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L146"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [168, 169]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 144,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L144"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 152,
|
|
"name": "listBuckets",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 78,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 153,
|
|
"name": "listBuckets",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Retrieves the details of all Storage buckets within an existing project."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing array of buckets or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "List buckets",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets()\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "List buckets with options",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .listBuckets({\n limit: 10,\n offset: 0,\n sortColumn: 'created_at',\n sortOrder: 'desc',\n search: 'prod'\n })\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 78,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L78"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 154,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Query parameters for listing buckets"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 629,
|
|
"name": "ListBucketOptions",
|
|
"package": "@supabase/storage-js",
|
|
"highlightedProperties": {
|
|
"limit": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Maximum number of buckets to return"
|
|
}
|
|
],
|
|
"offset": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Number of buckets to skip"
|
|
}
|
|
],
|
|
"sortColumn": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Column to sort by ('id', 'name', 'created_at', 'updated_at')"
|
|
}
|
|
],
|
|
"sortOrder": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Sort order ('asc' or 'desc')"
|
|
}
|
|
],
|
|
"search": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Search term to filter bucket names"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 155,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 156,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 80,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L80"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 619,
|
|
"name": "Bucket",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 157,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 81,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L81"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [156, 157]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 79,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L79"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 158,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 159,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 84,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L84"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 160,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 85,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L85"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [159, 160]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 83,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L83"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 150,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 41,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L41"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 151,
|
|
"name": "throwOnError",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Enable throwing errors instead of returning them."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 41,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L41"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 185,
|
|
"name": "updateBucket",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 283,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L283"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 186,
|
|
"name": "updateBucket",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Updates a Storage bucket"
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing success message or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Update bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .updateBucket('avatars', {\n public: false,\n allowedMimeTypes: ['image/png'],\n fileSizeLimit: 1024\n })\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"message\": \"Successfully updated\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 283,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L283"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 187,
|
|
"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": 188,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 189,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 192,
|
|
"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": 288,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L288"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 191,
|
|
"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": 287,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L287"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 190,
|
|
"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": 286,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L286"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [192, 191, 190]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 285,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L285"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 193,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 194,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 292,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L292"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 195,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 196,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 292,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L292"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [196]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 292,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L292"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 197,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 293,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L293"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [194, 197]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 291,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L291"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 198,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 199,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 296,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L296"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 200,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 297,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L297"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [199, 200]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 295,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L295"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [120]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [170, 212, 201, 161, 152, 150, 185]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "File Buckets",
|
|
"children": [170, 212, 201, 161, 152, 150, 185]
|
|
},
|
|
{
|
|
"title": "Other",
|
|
"children": [120]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 8,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L8"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"target": 504,
|
|
"name": "StorageClient"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"children": [119]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageBucketApi.ts",
|
|
"line": 1,
|
|
"character": 0,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageBucketApi.ts#L1"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 226,
|
|
"name": "packages/StorageFileApi",
|
|
"variant": "declaration",
|
|
"kind": 2,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 227,
|
|
"name": "default",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 228,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 52,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L52"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 229,
|
|
"name": "default",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 52,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L52"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 230,
|
|
"name": "url",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 231,
|
|
"name": "headers",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 232,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 54,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L54"
|
|
}
|
|
],
|
|
"indexSignatures": [
|
|
{
|
|
"id": 233,
|
|
"name": "__index",
|
|
"variant": "signature",
|
|
"kind": 8192,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 54,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L54"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 234,
|
|
"name": "key",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 235,
|
|
"name": "bucketId",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 236,
|
|
"name": "fetch",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 237,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
},
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 238,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 239,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInfo"
|
|
},
|
|
"name": "RequestInfo",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 240,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 241,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "node_modules/@types/node/globals.d.ts",
|
|
"line": 289,
|
|
"character": 13
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 242,
|
|
"name": "input",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Request"
|
|
},
|
|
"name": "Request",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 243,
|
|
"name": "init",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "RequestInit"
|
|
},
|
|
"name": "RequestInit",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 227,
|
|
"name": "StorageFileApi",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 351,
|
|
"name": "copy",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 558,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L558"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 352,
|
|
"name": "copy",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Copies an existing file to a new path in the same bucket."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing copied file path or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Copy file",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .copy('public/avatar1.png', 'private/avatar2.png')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"path\": \"avatars/private/avatar2.png\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 558,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L558"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 353,
|
|
"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": 354,
|
|
"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": 355,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The destination options."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 675,
|
|
"name": "DestinationOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 356,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 357,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 564,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L564"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 358,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 359,
|
|
"name": "path",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 564,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L564"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [359]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 564,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L564"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 360,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 565,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L565"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [357, 360]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 563,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L563"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"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": 568,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L568"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 363,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 569,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L569"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [362, 363]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 567,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L567"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 307,
|
|
"name": "createSignedUploadUrl",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 344,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L344"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 308,
|
|
"name": "createSignedUploadUrl",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a signed upload URL.\nSigned upload URLs can be used to upload files to the bucket without further authentication.\nThey are valid for 2 hours."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing signed upload URL, token, and path or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Create Signed Upload URL",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUploadUrl('folder/cat.jpg')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/upload/sign/avatars/folder/cat.jpg?token=<TOKEN>\",\n \"path\": \"folder/cat.jpg\",\n \"token\": \"<TOKEN>\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 344,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L344"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 309,
|
|
"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": 310,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 311,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 312,
|
|
"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": 346,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L346"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [312]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 346,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L346"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 313,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 314,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 349,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L349"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 315,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 318,
|
|
"name": "path",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 349,
|
|
"character": 50,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L349"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 316,
|
|
"name": "signedUrl",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 349,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L349"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 317,
|
|
"name": "token",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 349,
|
|
"character": 35,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L349"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [318, 316, 317]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 349,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L349"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 319,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 350,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L350"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [314, 319]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 348,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L348"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 320,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 321,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 353,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L353"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 322,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 354,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L354"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [321, 322]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 352,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L352"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 364,
|
|
"name": "createSignedUrl",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 648,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L648"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 365,
|
|
"name": "createSignedUrl",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing signed URL or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Create Signed URL",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUrl('folder/avatar1.png', 60)\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"signedUrl\": \"https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=<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```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 648,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L648"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 366,
|
|
"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": 367,
|
|
"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": 368,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 369,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 370,
|
|
"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": 651,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L651"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 371,
|
|
"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": 651,
|
|
"character": 45,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L651"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 709,
|
|
"name": "TransformOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [370, 371]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 651,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L651"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 372,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 373,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 654,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L654"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 374,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 375,
|
|
"name": "signedUrl",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 654,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L654"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [375]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 654,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L654"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 376,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 655,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L655"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [373, 376]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 653,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L653"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 377,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 378,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 658,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L658"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 379,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 659,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L659"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [378, 379]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 657,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L657"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 380,
|
|
"name": "createSignedUrls",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 727,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L727"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 381,
|
|
"name": "createSignedUrls",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing array of objects with signedUrl, path, and error or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Create Signed URLs",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .createSignedUrls(['folder/avatar1.png', 'folder/avatar2.png'], 60)\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": [\n {\n \"error\": null,\n \"path\": \"folder/avatar1.png\",\n \"signedURL\": \"/object/sign/avatars/folder/avatar1.png?token=<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```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 727,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L727"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 382,
|
|
"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": 383,
|
|
"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": 384,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 385,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 386,
|
|
"name": "download",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "triggers the file as a download if set to true. Set this parameter as the name of the file if you want to trigger the download with a different filename."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 730,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L730"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [386]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 730,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L730"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 387,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 388,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 733,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L733"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 389,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 390,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 733,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L733"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 391,
|
|
"name": "path",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 733,
|
|
"character": 38,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L733"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 392,
|
|
"name": "signedUrl",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 733,
|
|
"character": 59,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L733"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [390, 391, 392]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 733,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L733"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 393,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 734,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L734"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [388, 393]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 732,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L732"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 394,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 395,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 737,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L737"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 396,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 738,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L738"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [395, 396]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 736,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L736"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 397,
|
|
"name": "download",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 811,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L811"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 398,
|
|
"name": "download",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`getPublicUrl`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " instead."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "BlobDownloadBuilder instance for downloading the file"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Download file",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .download('folder/avatar1.png')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": <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```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 811,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L811"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 399,
|
|
"name": "Options",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 400,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 401,
|
|
"name": "transform",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 811,
|
|
"character": 29,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L811"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 709,
|
|
"name": "TransformOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [401]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 811,
|
|
"character": 27,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L811"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 402,
|
|
"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": 403,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 399,
|
|
"name": "Options",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 3,
|
|
"name": "BlobDownloadBuilder",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 413,
|
|
"name": "exists",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 888,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L888"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 414,
|
|
"name": "exists",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Checks the existence of a file."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing boolean indicating file existence or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Check file existence",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .exists('folder/avatar1.png')\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 888,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L888"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 415,
|
|
"name": "path",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The file path, including the file name. For example "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`folder/image.png`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 416,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 417,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 890,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L890"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 418,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 891,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L891"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [417, 418]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 889,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L889"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 419,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 420,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 894,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L894"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 421,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 895,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L895"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [420, 421]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 893,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L893"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 422,
|
|
"name": "getPublicUrl",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 972,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L972"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 423,
|
|
"name": "getPublicUrl",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "A simple convenience function to get the URL for an asset in a public bucket. If you do not want to use this function, you can construct the public URL by concatenating the bucket URL with the path to the asset.\nThis function does not verify if the bucket is public. If a public URL is created for a bucket which is not public, you will not be able to download the asset."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Object with public URL"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Returns the URL for an asset in a public bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"publicUrl\": \"https://example.supabase.co/storage/v1/object/public/public-bucket/folder/avatar1.png\"\n }\n}\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Returns the URL for an asset in a public bucket with transformations",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png', {\n transform: {\n width: 100,\n height: 100,\n }\n })\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Returns the URL which triggers the download of an asset in a public bucket",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data } = supabase\n .storage\n .from('public-bucket')\n .getPublicUrl('folder/avatar1.png', {\n download: true,\n })\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 972,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L972"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 424,
|
|
"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": 425,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 426,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 427,
|
|
"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": 974,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L974"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 428,
|
|
"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": 974,
|
|
"character": 45,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L974"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 709,
|
|
"name": "TransformOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [427, 428]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 974,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L974"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"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": 975,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L975"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 431,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 432,
|
|
"name": "publicUrl",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 975,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L975"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [432]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 975,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L975"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [430]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 975,
|
|
"character": 5,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L975"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 404,
|
|
"name": "info",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 843,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L843"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 405,
|
|
"name": "info",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Retrieves the details of an existing file."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing file metadata or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Get file info",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .info('folder/avatar1.png')\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 843,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L843"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 406,
|
|
"name": "path",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The file path, including the file name. For example "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`folder/image.png`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 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": 845,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L845"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 715,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 651,
|
|
"name": "FileObjectV2",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
],
|
|
"name": "Camelize",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 409,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 846,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L846"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [408, 409]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 844,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L844"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 410,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 411,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 849,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L849"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 412,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 850,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L850"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [411, 412]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 848,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L848"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 442,
|
|
"name": "list",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1180,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1180"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 443,
|
|
"name": "list",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Lists all the files and folders within a path of the bucket."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing array of files 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```"
|
|
},
|
|
{
|
|
"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```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1180,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1180"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 444,
|
|
"name": "path",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The folder path."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 445,
|
|
"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": 677,
|
|
"name": "SearchOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 446,
|
|
"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": 705,
|
|
"name": "FetchParameters",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 447,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 448,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1186,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1186"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 641,
|
|
"name": "FileObject",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 449,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1187,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1187"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [448, 449]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1185,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1185"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 450,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 451,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1190,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1190"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 452,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1191,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1191"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [451, 452]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1189,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1189"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 453,
|
|
"name": "listV2",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1223,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1223"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 454,
|
|
"name": "listV2",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "this method signature might change in the future"
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"modifierTags": ["@experimental"]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1223,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1223"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 455,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "search options"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 685,
|
|
"name": "SearchV2Options",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 456,
|
|
"name": "parameters",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 705,
|
|
"name": "FetchParameters",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 457,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 458,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1228,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1228"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 700,
|
|
"name": "SearchV2Result",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 459,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1229,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1229"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [458, 459]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1227,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1227"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 460,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 461,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1232,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1232"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 462,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1233,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1233"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [461, 462]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1231,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1231"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 338,
|
|
"name": "move",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 492,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L492"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 339,
|
|
"name": "move",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Moves an existing file to a new path in the same bucket."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing success message or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Move file",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .move('public/avatar1.png', 'private/avatar2.png')\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"message\": \"Successfully moved\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 492,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L492"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 340,
|
|
"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": 341,
|
|
"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": 342,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The destination options."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 675,
|
|
"name": "DestinationOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 343,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 344,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 498,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L498"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 345,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 346,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 498,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L498"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [346]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 498,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L498"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 347,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 499,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L499"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [344, 347]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 497,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L497"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 348,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 349,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 502,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L502"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 350,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 503,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L503"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [349, 350]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 501,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L501"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 433,
|
|
"name": "remove",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1028,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1028"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 434,
|
|
"name": "remove",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Deletes files within the same bucket"
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing array of deleted file objects or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Delete file",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .remove(['folder/avatar1.png'])\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": [],\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1028,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1028"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 435,
|
|
"name": "paths",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "An array of files to delete, including the path and file name. For example ["
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`'folder/image.png'`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "]."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 436,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 437,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1030,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1030"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 641,
|
|
"name": "FileObject",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 438,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1031,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1031"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [437, 438]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1029,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1029"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 439,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 440,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1034,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1034"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 441,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1035,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1035"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [440, 441]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1033,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1033"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 259,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isPublic": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 69,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L69"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 260,
|
|
"name": "throwOnError",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Enable throwing errors instead of returning them."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 69,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L69"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 466,
|
|
"name": "toBase64",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1262,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1262"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 467,
|
|
"name": "toBase64",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1262,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1262"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 468,
|
|
"name": "data",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 323,
|
|
"name": "update",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 438,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L438"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 324,
|
|
"name": "update",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Replaces an existing file at the specified path with a new one."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing file path, id, and fullPath or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Update file",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst avatarFile = event.target.files[0]\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .update('public/avatar1.png', avatarFile, {\n cacheControl: '3600',\n upsert: true\n })\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"path\": \"public/avatar1.png\",\n \"fullPath\": \"avatars/public/avatar1.png\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Update file using `ArrayBuffer` from base64 file data",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nimport {decode} from 'base64-arraybuffer'\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .update('public/avatar1.png', decode('base64FileData'), {\n contentType: 'image/png'\n })\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 438,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L438"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 325,
|
|
"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": 326,
|
|
"name": "fileBody",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The body of the file to be stored in the bucket."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "ArrayBuffer"
|
|
},
|
|
"name": "ArrayBuffer",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "ReadableStream"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Uint8Array"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "ArrayBufferLike"
|
|
},
|
|
"name": "ArrayBufferLike",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Uint8Array",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "ReadableStream",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Blob"
|
|
},
|
|
"name": "Blob",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "File"
|
|
},
|
|
"name": "File",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "FormData"
|
|
},
|
|
"name": "FormData",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "__global.NodeJS.ReadableStream"
|
|
},
|
|
"name": "ReadableStream",
|
|
"package": "@types/node",
|
|
"qualifiedName": "__global.NodeJS.ReadableStream"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URLSearchParams"
|
|
},
|
|
"name": "URLSearchParams",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "ArrayBufferView"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "ArrayBufferLike"
|
|
},
|
|
"name": "ArrayBufferLike",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "ArrayBufferView",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/@types/node/buffer.buffer.d.ts",
|
|
"qualifiedName": "__global.Buffer"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "ArrayBufferLike"
|
|
},
|
|
"name": "ArrayBufferLike",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Buffer",
|
|
"package": "@types/node",
|
|
"qualifiedName": "__global.Buffer"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 327,
|
|
"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": 668,
|
|
"name": "FileOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 328,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 329,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 454,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L454"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 330,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 333,
|
|
"name": "fullPath",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 454,
|
|
"character": 42,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L454"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 331,
|
|
"name": "id",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 454,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L454"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 332,
|
|
"name": "path",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 454,
|
|
"character": 28,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L454"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [333, 331, 332]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 454,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L454"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 334,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 455,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L455"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [329, 334]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 453,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L453"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 335,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 336,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 458,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L458"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 337,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 459,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L459"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [336, 337]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 457,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L457"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 277,
|
|
"name": "upload",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 215,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L215"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 278,
|
|
"name": "upload",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Uploads a file to an existing bucket."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing file path, id, and fullPath or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Upload file",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst avatarFile = event.target.files[0]\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', avatarFile, {\n cacheControl: '3600',\n upsert: false\n })\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"path\": \"public/avatar1.png\",\n \"fullPath\": \"avatars/public/avatar1.png\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Upload file using `ArrayBuffer` from base64 file data",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nimport { decode } from 'base64-arraybuffer'\n\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .upload('public/avatar1.png', decode('base64FileData'), {\n contentType: 'image/png'\n })\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 215,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L215"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 279,
|
|
"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": 280,
|
|
"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": 281,
|
|
"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": 668,
|
|
"name": "FileOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 282,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 283,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 221,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L221"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 284,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 287,
|
|
"name": "fullPath",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 221,
|
|
"character": 42,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L221"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 285,
|
|
"name": "id",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 221,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L221"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 286,
|
|
"name": "path",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 221,
|
|
"character": 28,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L221"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [287, 285, 286]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 221,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L221"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 288,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 222,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L222"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [283, 288]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 220,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L220"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 289,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 290,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L225"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 291,
|
|
"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/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L226"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [290, 291]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 224,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L224"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 292,
|
|
"name": "uploadToSignedUrl",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 263,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L263"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 293,
|
|
"name": "uploadToSignedUrl",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Upload a file with a token generated from "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`createSignedUploadUrl`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "File Buckets"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Promise with response containing file path and fullPath or error"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Upload to a signed URL",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```js\nconst { data, error } = await supabase\n .storage\n .from('avatars')\n .uploadToSignedUrl('folder/cat.jpg', 'token-from-createSignedUploadUrl', file)\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nResponse:\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"data\": {\n \"path\": \"folder/cat.jpg\",\n \"fullPath\": \"avatars/folder/cat.jpg\"\n },\n \"error\": null\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 263,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L263"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 294,
|
|
"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": 295,
|
|
"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": 296,
|
|
"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": 297,
|
|
"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": 668,
|
|
"name": "FileOptions",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 298,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 299,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 299,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L299"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 300,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 302,
|
|
"name": "fullPath",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 299,
|
|
"character": 33,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L299"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
},
|
|
"defaultValue": "data.Key"
|
|
},
|
|
{
|
|
"id": 301,
|
|
"name": "path",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 299,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L299"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "cleanPath"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [302, 301]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 299,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L299"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 303,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 300,
|
|
"character": 8,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L300"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
"defaultValue": "null"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [299, 303]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 298,
|
|
"character": 13,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L298"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 304,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 305,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 307,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L307"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
"defaultValue": "null"
|
|
},
|
|
{
|
|
"id": 306,
|
|
"name": "error",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 307,
|
|
"character": 29,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L307"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 728,
|
|
"name": "StorageError",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [305, 306]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 307,
|
|
"character": 15,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L307"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [228]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [
|
|
351, 307, 364, 380, 397, 413, 422, 404, 442, 453, 338, 433, 259, 466, 323, 277, 292
|
|
]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "File Buckets",
|
|
"children": [
|
|
351, 307, 364, 380, 397, 413, 422, 404, 442, 453, 338, 433, 259, 323, 277, 292
|
|
]
|
|
},
|
|
{
|
|
"title": "Other",
|
|
"children": [228, 466]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 45,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L45"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"children": [227]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StorageFileApi.ts",
|
|
"line": 1,
|
|
"character": 0,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StorageFileApi.ts#L1"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 478,
|
|
"name": "packages/StreamDownloadBuilder",
|
|
"variant": "declaration",
|
|
"kind": 2,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 479,
|
|
"name": "default",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 480,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 5,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L5"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 481,
|
|
"name": "default",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 5,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L5"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 482,
|
|
"name": "downloadFn",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 483,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 6,
|
|
"character": 24,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L6"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 484,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 6,
|
|
"character": 24,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L6"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Response"
|
|
},
|
|
"name": "Response",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 485,
|
|
"name": "shouldThrowOnError",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 479,
|
|
"name": "StreamDownloadBuilder",
|
|
"package": "@supabase/storage-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 490,
|
|
"name": "then",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 10,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L10"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 491,
|
|
"name": "then",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Attaches callbacks for the resolution and/or rejection of the Promise."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "A Promise for the completion of which ever callback is executed."
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 10,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L10"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 492,
|
|
"name": "TResult1",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"target": 717,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "ReadableStream"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "ReadableStream",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "DownloadResult",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 493,
|
|
"name": "TResult2",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 494,
|
|
"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": 495,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 12,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L12"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 496,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 12,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L12"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 497,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 717,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "ReadableStream"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
],
|
|
"name": "ReadableStream",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "DownloadResult",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 492,
|
|
"name": "TResult1",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "PromiseLike"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 492,
|
|
"name": "TResult1",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 498,
|
|
"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": 499,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 14,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L14"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 500,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 14,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L14"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 501,
|
|
"name": "reason",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 493,
|
|
"name": "TResult2",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "PromiseLike"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 493,
|
|
"name": "TResult2",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "Promise"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 492,
|
|
"name": "TResult1",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 493,
|
|
"name": "TResult2",
|
|
"package": "@supabase/storage-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "Promise",
|
|
"package": "typescript"
|
|
},
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "PromiseLike.then"
|
|
}
|
|
}
|
|
],
|
|
"implementationOf": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "PromiseLike.then"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [480]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [490]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 4,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L4"
|
|
}
|
|
],
|
|
"implementedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "PromiseLike"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 717,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "ReadableStream"
|
|
},
|
|
"name": "ReadableStream",
|
|
"package": "typescript"
|
|
}
|
|
],
|
|
"name": "DownloadResult",
|
|
"package": "@supabase/storage-js"
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"children": [479]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/storage-js/src/packages/StreamDownloadBuilder.ts",
|
|
"line": 1,
|
|
"character": 0,
|
|
"url": "https://github.com/supabase/supabase-js/blob/a9dffc2da140c16d3a77716d0ec28a506b3315df/packages/core/storage-js/src/packages/StreamDownloadBuilder.ts#L1"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Modules",
|
|
"children": [1, 2, 46, 118, 226, 478]
|
|
}
|
|
],
|
|
"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/anon 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\nThe storage-js package uses multiple build scripts to generate different module formats for various JavaScript environments:\n\n| Script | Description | Output |\n| -------------- | --------------------------- | --------------------------------------------------------------- |\n| "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`build`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " | **Complete build pipeline** | Runs all build steps in sequence |\n| "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`build:main`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " | **CommonJS build** | "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/main/`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " - Node.js compatible CommonJS modules |\n| "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`build:module`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " | **ES Modules build** | "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/module/`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " - Modern ES6 modules with TypeScript definitions |\n| "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`build:umd`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " | **UMD build** | "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/umd/`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " - Universal Module Definition for browsers/CDN |\n| "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`clean`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " | **Clean build artifacts** | Removes "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " and "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`docs/v2/`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " directories |\n\n#### Running Builds\n\n##### Complete Build (Recommended)\n\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```bash\n# From the monorepo root\nnpx nx build storage-js\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nThis command executes the full build pipeline:\n\n1. **Cleans** - Removes any existing build artifacts\n2. **Formats** - Ensures consistent code formatting\n3. **Builds CommonJS** - For Node.js environments ("
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/main/`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ")\n4. **Builds ES Modules** - For modern bundlers ("
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/module/`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ")\n5. **Builds UMD** - For browser script tags ("
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/umd/`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ")\n\n##### Development Build with Watch Mode\n\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```bash\n# Continuously rebuild on file changes (from monorepo root)\nnpx nx build storage-js --watch\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\n##### Individual Build Targets\n\nFor specific build outputs during development:\n\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```bash\n# Build CommonJS only (Node.js)\nnpx nx build:main storage-js\n\n# Build ES Modules only (Modern bundlers)\nnpx nx build:module storage-js\n\n# Build UMD only (Browser/CDN)\nnpx nx build:umd storage-js\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\n##### Other Useful Commands\n\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```bash\n# Clean build artifacts\nnpx nx clean storage-js\n\n# Format code\nnpx nx format storage-js\n\n# Type checking\nnpx nx typecheck storage-js\n\n# Generate documentation\nnpx nx docs storage-js\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\n#### Build Outputs Explained\n\n##### CommonJS ("
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/main/`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ")\n\n- **Used by:** Node.js applications, older build tools\n- **Entry point:** "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/main/index.js`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n- **Module format:** "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`require()`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " and "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`module.exports`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n- **TypeScript definitions:** Included\n\n##### ES Modules ("
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/module/`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ")\n\n- **Used by:** Modern bundlers (Webpack, Rollup, Vite)\n- **Entry point:** "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/module/index.js`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n- **Module format:** "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`import`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " and "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`export`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n- **TypeScript definitions:** "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/module/index.d.ts`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n- **Benefits:** Tree-shaking, better static analysis\n\n##### UMD ("
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/umd/`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ")\n\n- **Used by:** Browser "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`<script>`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " tags, CDNs\n- **Entry point:** "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`dist/umd/supabase.js`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n- **Global variable:** "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`window.supabase`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n- **Size:** Larger (includes all dependencies)\n- **Usage example:**\n "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```html\n <script src=\"https://unpkg.com/@supabase/storage-js/dist/umd/supabase.js\"></script>\n <script>\n const { StorageClient } = window.supabase\n </script>\n ```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\n#### Package Exports\n\nThe package.json exports are configured to provide the right format for each environment:\n\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```json\n{\n \"main\": \"dist/main/index.js\",\n \"module\": \"dist/module/index.js\",\n \"types\": \"dist/module/index.d.ts\",\n \"jsdelivr\": \"dist/umd/supabase.js\",\n \"unpkg\": \"dist/umd/supabase.js\"\n}\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\n- **main** → Node.js environments (CommonJS format)\n- **module** → Modern bundlers like Webpack, Vite, Rollup (ES Modules)\n- **types** → TypeScript type definitions\n- **jsdelivr/unpkg** → CDN usage via "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`<script>`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " tags (UMD format)\n\n### Testing\n\n**Important:** The storage-js tests require a local test infrastructure running in Docker. This is **NOT** the same as a regular Supabase instance - it's a specialized test setup with its own storage API, database, and Kong gateway.\n\n#### Prerequisites\n\n1. **Docker** must be installed and running\n2. **Port availability** - The following ports must be free:\n - 5432 (PostgreSQL database)\n - 5050 (Storage API - sometimes 5000 conflicts macOS AirPlay conflict)\n - 8000 (Kong API Gateway)\n - 50020 (imgproxy for image transformations)\n\n**Note:** If port 5000 conflicts with macOS AirPlay Receiver, the docker-compose.yml has been configured to use port 5050 instead.\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 Docker containers for storage API, database, and Kong |\n| "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`test:clean`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " | **Stop and clean infrastructure** | Stops all Docker containers and removes them |\n\n#### Running Tests\n\n##### Option 1: Complete Test Run (Recommended)\n\nThis handles everything automatically - starting infrastructure, running tests, and cleaning up:\n\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```bash\n# From monorepo root\nnpx nx test:storage storage-js\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\nThis command will:\n\n1. Stop any existing test containers\n2. Build and start fresh test infrastructure\n3. Wait for services to be ready\n4. Run all Jest tests with coverage\n5. Clean up all containers after tests complete\n\n##### Option 2: Manual Infrastructure Management\n\nUseful for development when you want to run tests multiple times without restarting Docker:\n\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```bash\n# Step 1: Start the test infrastructure\n# From root\nnpx nx test:infra storage-js\n# This starts: PostgreSQL, Storage API, Kong Gateway, and imgproxy\n\n# Step 2: Run tests (can run multiple times)\nnpx nx test:suite storage-js\n\n# Step 3: When done, clean up the infrastructure\nnpx nx test:clean storage-js\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\n##### Option 3: Development Mode\n\nFor actively developing and debugging tests:\n\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```bash\n# Start infrastructure once (from root)\nnpx nx test:infra storage-js\n\n# Run tests in watch mode\nnpx nx test:suite storage-js --watch\n\n# Clean up when done\nnpx nx test:clean storage-js\n```"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "\n\n#### Test Infrastructure Details\n\nThe test infrastructure ("
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`infra/docker-compose.yml`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ") includes:\n\n- **PostgreSQL Database** (port 5432)\n - Initialized with storage schema and test data\n - Contains bucket configurations and permissions\n\n- **Storage API** (port 5050, internal 5000)\n - Supabase Storage service for handling file operations\n - Configured with test authentication keys\n\n- **Kong Gateway** (port 8000)\n - API gateway that routes requests to storage service\n - Handles authentication and CORS\n\n- **imgproxy** (port 50020)\n - Image transformation service for on-the-fly image processing\n\n#### Common Issues and Solutions\n\n| Issue | Solution |\n| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n| Port 5000 already in use | macOS AirPlay uses this port. Either disable AirPlay Receiver in System Settings or use the modified docker-compose.yml with port 5050 |\n| Port 5432 already in use | Another PostgreSQL instance is running. Stop it or modify the port in docker-compose.yml |\n| \"request failed, reason:\" errors | Infrastructure isn't running. Run "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`npx nx test:infra storage-js`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " first |\n| Tests fail with connection errors | Ensure Docker is running and healthy |\n| \"Container name already exists\" | Run "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`npx nx test:clean storage-js`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " to remove existing containers |\n\n#### Understanding Test Failures\n\n- **StorageUnknownError with \"request failed\"**: Infrastructure not running\n- **Port binding errors**: Ports are already in use by other services\n- **Snapshot failures**: Expected test data has changed - review and update snapshots if needed\n\n#### What About Supabase CLI?\n\n**No**, you don't need "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`supabase start`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " or a regular Supabase instance for these tests. The storage-js tests use their own specialized Docker setup that's lighter and focused specifically on testing the storage SDK. This test infrastructure:\n\n- Is completely independent from any Supabase CLI projects\n- Uses fixed test authentication keys\n- Has predictable test data and bucket configurations\n- Runs faster than a full Supabase stack\n- Doesn't interfere with your local Supabase development projects\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide]("
|
|
},
|
|
{
|
|
"kind": "relative-link",
|
|
"text": "../../../CONTRIBUTING.md",
|
|
"target": 7
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes."
|
|
}
|
|
],
|
|
"symbolIdMap": {
|
|
"1": {
|
|
"sourceFileName": "src/index.ts",
|
|
"qualifiedName": ""
|
|
},
|
|
"2": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": ""
|
|
},
|
|
"3": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"4": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default.__constructor"
|
|
},
|
|
"5": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"6": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "downloadFn"
|
|
},
|
|
"7": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"8": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"9": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "shouldThrowOnError"
|
|
},
|
|
"15": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default.asStream"
|
|
},
|
|
"16": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default.asStream"
|
|
},
|
|
"17": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"18": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"19": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "TResult1"
|
|
},
|
|
"20": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "TResult2"
|
|
},
|
|
"21": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "onfulfilled"
|
|
},
|
|
"22": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"23": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"24": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"25": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "onrejected"
|
|
},
|
|
"26": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"27": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"28": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "reason"
|
|
},
|
|
"29": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default.catch"
|
|
},
|
|
"30": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default.catch"
|
|
},
|
|
"31": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "TResult"
|
|
},
|
|
"32": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "onrejected"
|
|
},
|
|
"33": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"34": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"35": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "reason"
|
|
},
|
|
"36": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default.finally"
|
|
},
|
|
"37": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default.finally"
|
|
},
|
|
"38": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "onfinally"
|
|
},
|
|
"39": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"40": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"45": {
|
|
"sourceFileName": "src/packages/BlobDownloadBuilder.ts",
|
|
"qualifiedName": "default.[toStringTag]"
|
|
},
|
|
"46": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": ""
|
|
},
|
|
"47": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "WrappedIcebergRestCatalog"
|
|
},
|
|
"48": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"49": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default.__constructor"
|
|
},
|
|
"50": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"51": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"52": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "headers"
|
|
},
|
|
"53": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"54": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"56": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"57": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"58": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"59": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"60": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"61": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"62": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"63": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"78": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"79": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"80": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default.createBucket"
|
|
},
|
|
"81": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default.createBucket"
|
|
},
|
|
"82": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "name"
|
|
},
|
|
"83": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"84": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"85": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"86": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"87": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"88": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"89": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default.listBuckets"
|
|
},
|
|
"90": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default.listBuckets"
|
|
},
|
|
"91": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"92": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"93": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.limit"
|
|
},
|
|
"94": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.offset"
|
|
},
|
|
"95": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.sortColumn"
|
|
},
|
|
"96": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.sortOrder"
|
|
},
|
|
"97": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.search"
|
|
},
|
|
"98": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"99": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"100": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"101": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"102": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"103": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"104": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default.deleteBucket"
|
|
},
|
|
"105": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default.deleteBucket"
|
|
},
|
|
"106": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "bucketName"
|
|
},
|
|
"107": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"108": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"109": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"110": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"111": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"112": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"113": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"114": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"115": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default.from"
|
|
},
|
|
"116": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "default.from"
|
|
},
|
|
"117": {
|
|
"sourceFileName": "src/packages/StorageAnalyticsClient.ts",
|
|
"qualifiedName": "bucketName"
|
|
},
|
|
"118": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": ""
|
|
},
|
|
"119": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"120": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.__constructor"
|
|
},
|
|
"121": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"122": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"123": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "headers"
|
|
},
|
|
"124": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"125": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"127": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"128": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"129": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"130": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"131": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"132": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"133": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"134": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"135": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "opts"
|
|
},
|
|
"150": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"151": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"152": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.listBuckets"
|
|
},
|
|
"153": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.listBuckets"
|
|
},
|
|
"154": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"155": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"156": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"157": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"158": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"159": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"160": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"161": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.getBucket"
|
|
},
|
|
"162": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.getBucket"
|
|
},
|
|
"163": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"164": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"165": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"166": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"167": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"168": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"169": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"170": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.createBucket"
|
|
},
|
|
"171": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.createBucket"
|
|
},
|
|
"172": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"173": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"174": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"175": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.public"
|
|
},
|
|
"176": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.fileSizeLimit"
|
|
},
|
|
"177": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.allowedMimeTypes"
|
|
},
|
|
"178": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.type"
|
|
},
|
|
"179": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"180": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"181": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"182": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"183": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"184": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"185": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.updateBucket"
|
|
},
|
|
"186": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.updateBucket"
|
|
},
|
|
"187": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"188": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"189": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"190": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.public"
|
|
},
|
|
"191": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.fileSizeLimit"
|
|
},
|
|
"192": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.allowedMimeTypes"
|
|
},
|
|
"193": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"194": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"195": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"196": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"197": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"198": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"199": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"200": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"201": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.emptyBucket"
|
|
},
|
|
"202": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.emptyBucket"
|
|
},
|
|
"203": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"204": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"205": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"206": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"207": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"208": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"209": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"210": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"211": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"212": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.deleteBucket"
|
|
},
|
|
"213": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.deleteBucket"
|
|
},
|
|
"214": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"215": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"216": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"217": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"218": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"219": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"220": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"221": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"222": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"226": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": ""
|
|
},
|
|
"227": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"228": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.__constructor"
|
|
},
|
|
"229": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"230": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"231": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "headers"
|
|
},
|
|
"232": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"233": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"235": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "bucketId"
|
|
},
|
|
"236": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"237": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"238": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"239": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"240": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"241": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"242": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"243": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"259": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"260": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"277": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.upload"
|
|
},
|
|
"278": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.upload"
|
|
},
|
|
"279": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"280": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "fileBody"
|
|
},
|
|
"281": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "fileOptions"
|
|
},
|
|
"282": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"283": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"284": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"285": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.id"
|
|
},
|
|
"286": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.path"
|
|
},
|
|
"287": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.fullPath"
|
|
},
|
|
"288": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"289": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"290": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"291": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"292": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.uploadToSignedUrl"
|
|
},
|
|
"293": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.uploadToSignedUrl"
|
|
},
|
|
"294": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"295": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "token"
|
|
},
|
|
"296": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "fileBody"
|
|
},
|
|
"297": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "fileOptions"
|
|
},
|
|
"298": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__object"
|
|
},
|
|
"299": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__object.data"
|
|
},
|
|
"300": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__object"
|
|
},
|
|
"301": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__object.path"
|
|
},
|
|
"302": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__object.fullPath"
|
|
},
|
|
"303": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__object.error"
|
|
},
|
|
"304": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__object"
|
|
},
|
|
"305": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__object.data"
|
|
},
|
|
"306": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__object.error"
|
|
},
|
|
"307": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.createSignedUploadUrl"
|
|
},
|
|
"308": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.createSignedUploadUrl"
|
|
},
|
|
"309": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"310": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"311": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"312": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.upsert"
|
|
},
|
|
"313": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"314": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"315": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"316": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.signedUrl"
|
|
},
|
|
"317": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.token"
|
|
},
|
|
"318": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.path"
|
|
},
|
|
"319": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"320": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"321": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"322": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"323": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.update"
|
|
},
|
|
"324": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.update"
|
|
},
|
|
"325": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"326": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "fileBody"
|
|
},
|
|
"327": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "fileOptions"
|
|
},
|
|
"328": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"329": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"330": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"331": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.id"
|
|
},
|
|
"332": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.path"
|
|
},
|
|
"333": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.fullPath"
|
|
},
|
|
"334": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"335": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"336": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"337": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"338": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.move"
|
|
},
|
|
"339": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.move"
|
|
},
|
|
"340": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "fromPath"
|
|
},
|
|
"341": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "toPath"
|
|
},
|
|
"342": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"343": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"344": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"345": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"346": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"347": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"348": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"349": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"350": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"351": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.copy"
|
|
},
|
|
"352": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.copy"
|
|
},
|
|
"353": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "fromPath"
|
|
},
|
|
"354": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "toPath"
|
|
},
|
|
"355": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"356": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"357": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"358": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"359": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.path"
|
|
},
|
|
"360": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"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.error"
|
|
},
|
|
"364": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.createSignedUrl"
|
|
},
|
|
"365": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.createSignedUrl"
|
|
},
|
|
"366": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"367": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "expiresIn"
|
|
},
|
|
"368": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"369": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"370": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.download"
|
|
},
|
|
"371": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.transform"
|
|
},
|
|
"372": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"373": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"374": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"375": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.signedUrl"
|
|
},
|
|
"376": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"377": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"378": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"379": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"380": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.createSignedUrls"
|
|
},
|
|
"381": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.createSignedUrls"
|
|
},
|
|
"382": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "paths"
|
|
},
|
|
"383": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "expiresIn"
|
|
},
|
|
"384": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"385": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"386": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.download"
|
|
},
|
|
"387": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"388": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"389": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"390": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"391": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.path"
|
|
},
|
|
"392": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.signedUrl"
|
|
},
|
|
"393": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"394": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"395": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"396": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"397": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.download"
|
|
},
|
|
"398": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.download"
|
|
},
|
|
"399": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "Options"
|
|
},
|
|
"400": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"401": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.transform"
|
|
},
|
|
"402": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"403": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"404": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.info"
|
|
},
|
|
"405": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.info"
|
|
},
|
|
"406": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"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.error"
|
|
},
|
|
"410": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"411": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"412": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"413": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.exists"
|
|
},
|
|
"414": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.exists"
|
|
},
|
|
"415": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"416": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"417": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"418": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"419": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"420": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"421": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"422": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.getPublicUrl"
|
|
},
|
|
"423": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.getPublicUrl"
|
|
},
|
|
"424": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"425": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"426": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"427": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.download"
|
|
},
|
|
"428": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.transform"
|
|
},
|
|
"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"
|
|
},
|
|
"432": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.publicUrl"
|
|
},
|
|
"433": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.remove"
|
|
},
|
|
"434": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.remove"
|
|
},
|
|
"435": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "paths"
|
|
},
|
|
"436": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"437": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"438": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"439": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"440": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"441": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"442": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.list"
|
|
},
|
|
"443": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.list"
|
|
},
|
|
"444": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "path"
|
|
},
|
|
"445": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"446": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "parameters"
|
|
},
|
|
"447": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"448": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"449": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"450": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"451": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"452": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"453": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.listV2"
|
|
},
|
|
"454": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.listV2"
|
|
},
|
|
"455": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"456": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "parameters"
|
|
},
|
|
"457": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"458": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"459": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"460": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"461": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"462": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"466": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.toBase64"
|
|
},
|
|
"467": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "default.toBase64"
|
|
},
|
|
"468": {
|
|
"sourceFileName": "src/packages/StorageFileApi.ts",
|
|
"qualifiedName": "data"
|
|
},
|
|
"478": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": ""
|
|
},
|
|
"479": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"480": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default.__constructor"
|
|
},
|
|
"481": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"482": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "downloadFn"
|
|
},
|
|
"483": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"484": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"485": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "shouldThrowOnError"
|
|
},
|
|
"490": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"491": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"492": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "TResult1"
|
|
},
|
|
"493": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "TResult2"
|
|
},
|
|
"494": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "onfulfilled"
|
|
},
|
|
"495": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"496": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"497": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"498": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "onrejected"
|
|
},
|
|
"499": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"500": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"501": {
|
|
"sourceFileName": "src/packages/StreamDownloadBuilder.ts",
|
|
"qualifiedName": "reason"
|
|
},
|
|
"504": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient"
|
|
},
|
|
"505": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.__constructor"
|
|
},
|
|
"506": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient"
|
|
},
|
|
"507": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"508": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "headers"
|
|
},
|
|
"509": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"510": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"512": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"513": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"514": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"515": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"516": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"517": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"518": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"519": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"520": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "opts"
|
|
},
|
|
"521": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.from"
|
|
},
|
|
"522": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.from"
|
|
},
|
|
"523": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"524": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.vectors"
|
|
},
|
|
"525": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.vectors"
|
|
},
|
|
"526": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.analytics"
|
|
},
|
|
"527": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClient.analytics"
|
|
},
|
|
"542": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"543": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"544": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.listBuckets"
|
|
},
|
|
"545": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.listBuckets"
|
|
},
|
|
"546": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"547": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"548": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"549": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"550": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"551": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"552": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"553": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.getBucket"
|
|
},
|
|
"554": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.getBucket"
|
|
},
|
|
"555": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"556": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"557": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"558": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"559": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"560": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"561": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"562": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.createBucket"
|
|
},
|
|
"563": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.createBucket"
|
|
},
|
|
"564": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"565": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"566": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"567": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.public"
|
|
},
|
|
"568": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.fileSizeLimit"
|
|
},
|
|
"569": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.allowedMimeTypes"
|
|
},
|
|
"570": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.type"
|
|
},
|
|
"571": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"572": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"573": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"574": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"575": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"576": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"577": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.updateBucket"
|
|
},
|
|
"578": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.updateBucket"
|
|
},
|
|
"579": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"580": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"581": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"582": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.public"
|
|
},
|
|
"583": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.fileSizeLimit"
|
|
},
|
|
"584": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.allowedMimeTypes"
|
|
},
|
|
"585": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"586": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"587": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"588": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"589": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"590": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"591": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"592": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"593": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.emptyBucket"
|
|
},
|
|
"594": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.emptyBucket"
|
|
},
|
|
"595": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"596": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"597": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"598": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"599": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"600": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"601": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"602": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"603": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"604": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.deleteBucket"
|
|
},
|
|
"605": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "default.deleteBucket"
|
|
},
|
|
"606": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "id"
|
|
},
|
|
"607": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"608": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"609": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"610": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"611": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"612": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"613": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"614": {
|
|
"sourceFileName": "src/packages/StorageBucketApi.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"615": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClientOptions"
|
|
},
|
|
"616": {
|
|
"sourceFileName": "src/StorageClient.ts",
|
|
"qualifiedName": "StorageClientOptions.useNewHostname"
|
|
},
|
|
"617": {
|
|
"sourceFileName": "src/index.ts",
|
|
"qualifiedName": "StorageAnalyticsClient"
|
|
},
|
|
"618": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "BucketType"
|
|
},
|
|
"619": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket"
|
|
},
|
|
"620": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.id"
|
|
},
|
|
"621": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.type"
|
|
},
|
|
"622": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.name"
|
|
},
|
|
"623": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.owner"
|
|
},
|
|
"624": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.file_size_limit"
|
|
},
|
|
"625": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.allowed_mime_types"
|
|
},
|
|
"626": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.created_at"
|
|
},
|
|
"627": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.updated_at"
|
|
},
|
|
"628": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Bucket.public"
|
|
},
|
|
"629": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions"
|
|
},
|
|
"630": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions.limit"
|
|
},
|
|
"631": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions.offset"
|
|
},
|
|
"632": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions.sortColumn"
|
|
},
|
|
"633": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions.sortOrder"
|
|
},
|
|
"634": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "ListBucketOptions.search"
|
|
},
|
|
"635": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket"
|
|
},
|
|
"636": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket.name"
|
|
},
|
|
"637": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket.type"
|
|
},
|
|
"638": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket.format"
|
|
},
|
|
"639": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket.created_at"
|
|
},
|
|
"640": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "AnalyticBucket.updated_at"
|
|
},
|
|
"641": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject"
|
|
},
|
|
"642": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.name"
|
|
},
|
|
"643": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.bucket_id"
|
|
},
|
|
"644": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.owner"
|
|
},
|
|
"645": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.id"
|
|
},
|
|
"646": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.updated_at"
|
|
},
|
|
"647": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.created_at"
|
|
},
|
|
"648": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.last_accessed_at"
|
|
},
|
|
"649": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.metadata"
|
|
},
|
|
"650": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObject.buckets"
|
|
},
|
|
"651": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2"
|
|
},
|
|
"652": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.id"
|
|
},
|
|
"653": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.version"
|
|
},
|
|
"654": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.name"
|
|
},
|
|
"655": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.bucket_id"
|
|
},
|
|
"656": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.updated_at"
|
|
},
|
|
"657": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.created_at"
|
|
},
|
|
"658": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.last_accessed_at"
|
|
},
|
|
"659": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.size"
|
|
},
|
|
"660": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.cache_control"
|
|
},
|
|
"661": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.content_type"
|
|
},
|
|
"662": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.etag"
|
|
},
|
|
"663": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.last_modified"
|
|
},
|
|
"664": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileObjectV2.metadata"
|
|
},
|
|
"665": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortBy"
|
|
},
|
|
"666": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortBy.column"
|
|
},
|
|
"667": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortBy.order"
|
|
},
|
|
"668": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions"
|
|
},
|
|
"669": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.cacheControl"
|
|
},
|
|
"670": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.contentType"
|
|
},
|
|
"671": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.upsert"
|
|
},
|
|
"672": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.duplex"
|
|
},
|
|
"673": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.metadata"
|
|
},
|
|
"674": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FileOptions.headers"
|
|
},
|
|
"675": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "DestinationOptions"
|
|
},
|
|
"676": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "DestinationOptions.destinationBucket"
|
|
},
|
|
"677": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchOptions"
|
|
},
|
|
"678": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchOptions.limit"
|
|
},
|
|
"679": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchOptions.offset"
|
|
},
|
|
"680": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchOptions.sortBy"
|
|
},
|
|
"681": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchOptions.search"
|
|
},
|
|
"682": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortByV2"
|
|
},
|
|
"683": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortByV2.column"
|
|
},
|
|
"684": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SortByV2.order"
|
|
},
|
|
"685": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options"
|
|
},
|
|
"686": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options.limit"
|
|
},
|
|
"687": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options.prefix"
|
|
},
|
|
"688": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options.cursor"
|
|
},
|
|
"689": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options.with_delimiter"
|
|
},
|
|
"690": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Options.sortBy"
|
|
},
|
|
"691": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object"
|
|
},
|
|
"692": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.id"
|
|
},
|
|
"693": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.key"
|
|
},
|
|
"694": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.name"
|
|
},
|
|
"695": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.updated_at"
|
|
},
|
|
"696": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.created_at"
|
|
},
|
|
"697": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.metadata"
|
|
},
|
|
"698": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Object.last_accessed_at"
|
|
},
|
|
"699": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Folder"
|
|
},
|
|
"700": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Result"
|
|
},
|
|
"701": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Result.hasNext"
|
|
},
|
|
"702": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Result.folders"
|
|
},
|
|
"703": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Result.objects"
|
|
},
|
|
"704": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "SearchV2Result.nextCursor"
|
|
},
|
|
"705": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FetchParameters"
|
|
},
|
|
"706": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "FetchParameters.signal"
|
|
},
|
|
"707": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Metadata"
|
|
},
|
|
"708": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Metadata.name"
|
|
},
|
|
"709": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions"
|
|
},
|
|
"710": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions.width"
|
|
},
|
|
"711": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions.height"
|
|
},
|
|
"712": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions.resize"
|
|
},
|
|
"713": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions.quality"
|
|
},
|
|
"714": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "TransformOptions.format"
|
|
},
|
|
"715": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "Camelize"
|
|
},
|
|
"716": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "T"
|
|
},
|
|
"717": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "DownloadResult"
|
|
},
|
|
"718": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"719": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"720": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"721": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"722": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type.data"
|
|
},
|
|
"723": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "__type.error"
|
|
},
|
|
"724": {
|
|
"sourceFileName": "src/lib/types.ts",
|
|
"qualifiedName": "T"
|
|
},
|
|
"725": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "isStorageError"
|
|
},
|
|
"726": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "isStorageError"
|
|
},
|
|
"727": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "error"
|
|
},
|
|
"728": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageError"
|
|
},
|
|
"729": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageError.__constructor"
|
|
},
|
|
"730": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageError"
|
|
},
|
|
"731": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"733": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageApiError"
|
|
},
|
|
"734": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageApiError.__constructor"
|
|
},
|
|
"735": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageApiError"
|
|
},
|
|
"736": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"737": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "status"
|
|
},
|
|
"738": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "statusCode"
|
|
},
|
|
"739": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageApiError.status"
|
|
},
|
|
"740": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageApiError.statusCode"
|
|
},
|
|
"741": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageApiError.toJSON"
|
|
},
|
|
"742": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageApiError.toJSON"
|
|
},
|
|
"743": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "__object"
|
|
},
|
|
"744": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "__object.name"
|
|
},
|
|
"745": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "__object.message"
|
|
},
|
|
"746": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "__object.status"
|
|
},
|
|
"747": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "__object.statusCode"
|
|
},
|
|
"749": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageUnknownError"
|
|
},
|
|
"750": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageUnknownError.__constructor"
|
|
},
|
|
"751": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageUnknownError"
|
|
},
|
|
"752": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"753": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "originalError"
|
|
},
|
|
"754": {
|
|
"sourceFileName": "src/lib/errors.ts",
|
|
"qualifiedName": "StorageUnknownError.originalError"
|
|
},
|
|
"756": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient"
|
|
},
|
|
"757": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.__constructor"
|
|
},
|
|
"758": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient"
|
|
},
|
|
"759": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"760": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"761": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.from"
|
|
},
|
|
"762": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.from"
|
|
},
|
|
"763": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"764": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.createBucket"
|
|
},
|
|
"765": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.createBucket"
|
|
},
|
|
"766": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"767": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.getBucket"
|
|
},
|
|
"768": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.getBucket"
|
|
},
|
|
"769": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"770": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"771": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type.vectorBucket"
|
|
},
|
|
"772": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.listBuckets"
|
|
},
|
|
"773": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.listBuckets"
|
|
},
|
|
"774": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"775": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.deleteBucket"
|
|
},
|
|
"776": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClient.deleteBucket"
|
|
},
|
|
"777": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"792": {
|
|
"sourceFileName": "src/lib/vectors/VectorBucketApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"793": {
|
|
"sourceFileName": "src/lib/vectors/VectorBucketApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"794": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope"
|
|
},
|
|
"795": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.__constructor"
|
|
},
|
|
"796": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope"
|
|
},
|
|
"797": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"798": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "headers"
|
|
},
|
|
"799": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"800": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"802": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"803": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"804": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"805": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"806": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"807": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"808": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"809": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"810": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"812": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.createIndex"
|
|
},
|
|
"813": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.createIndex"
|
|
},
|
|
"814": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"815": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.listIndexes"
|
|
},
|
|
"816": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.listIndexes"
|
|
},
|
|
"817": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"818": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.getIndex"
|
|
},
|
|
"819": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.getIndex"
|
|
},
|
|
"820": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "indexName"
|
|
},
|
|
"821": {
|
|
"sourceFileName": "src/lib/vectors/VectorIndexApi.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"822": {
|
|
"sourceFileName": "src/lib/vectors/VectorIndexApi.ts",
|
|
"qualifiedName": "__type.index"
|
|
},
|
|
"823": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.deleteIndex"
|
|
},
|
|
"824": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.deleteIndex"
|
|
},
|
|
"825": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "indexName"
|
|
},
|
|
"826": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.index"
|
|
},
|
|
"827": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorBucketScope.index"
|
|
},
|
|
"828": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "indexName"
|
|
},
|
|
"843": {
|
|
"sourceFileName": "src/lib/vectors/VectorIndexApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"844": {
|
|
"sourceFileName": "src/lib/vectors/VectorIndexApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"845": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope"
|
|
},
|
|
"846": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.__constructor"
|
|
},
|
|
"847": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope"
|
|
},
|
|
"848": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"849": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "headers"
|
|
},
|
|
"850": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"851": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"853": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "vectorBucketName"
|
|
},
|
|
"854": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "indexName"
|
|
},
|
|
"855": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"856": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"857": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"858": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"859": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"860": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"861": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"862": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"865": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.putVectors"
|
|
},
|
|
"866": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.putVectors"
|
|
},
|
|
"867": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"868": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.getVectors"
|
|
},
|
|
"869": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.getVectors"
|
|
},
|
|
"870": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"871": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.listVectors"
|
|
},
|
|
"872": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.listVectors"
|
|
},
|
|
"873": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"874": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.queryVectors"
|
|
},
|
|
"875": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.queryVectors"
|
|
},
|
|
"876": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"877": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.deleteVectors"
|
|
},
|
|
"878": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "VectorIndexScope.deleteVectors"
|
|
},
|
|
"879": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"894": {
|
|
"sourceFileName": "src/lib/vectors/VectorDataApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"895": {
|
|
"sourceFileName": "src/lib/vectors/VectorDataApi.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"896": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClientOptions"
|
|
},
|
|
"897": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClientOptions.headers"
|
|
},
|
|
"898": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"899": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"901": {
|
|
"sourceFileName": "src/lib/vectors/StorageVectorsClient.ts",
|
|
"qualifiedName": "StorageVectorsClientOptions.fetch"
|
|
},
|
|
"902": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"903": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"904": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"905": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"906": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"907": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"908": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"1050": {
|
|
"sourceFileName": "src/lib/vectors/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions"
|
|
},
|
|
"1051": {
|
|
"sourceFileName": "src/lib/vectors/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.vectorBucketName"
|
|
},
|
|
"1052": {
|
|
"sourceFileName": "src/lib/vectors/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.indexName"
|
|
},
|
|
"1053": {
|
|
"sourceFileName": "src/lib/vectors/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.dataType"
|
|
},
|
|
"1054": {
|
|
"sourceFileName": "src/lib/vectors/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.dimension"
|
|
},
|
|
"1055": {
|
|
"sourceFileName": "src/lib/vectors/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.distanceMetric"
|
|
},
|
|
"1056": {
|
|
"sourceFileName": "src/lib/vectors/VectorIndexApi.ts",
|
|
"qualifiedName": "CreateIndexOptions.metadataConfiguration"
|
|
},
|
|
"1057": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorBucket"
|
|
},
|
|
"1058": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorBucket.vectorBucketName"
|
|
},
|
|
"1059": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorBucket.creationTime"
|
|
},
|
|
"1060": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorBucket.encryptionConfiguration"
|
|
},
|
|
"1061": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorIndex"
|
|
},
|
|
"1062": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorIndex.indexName"
|
|
},
|
|
"1063": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorIndex.vectorBucketName"
|
|
},
|
|
"1064": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorIndex.dataType"
|
|
},
|
|
"1065": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorIndex.dimension"
|
|
},
|
|
"1066": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorIndex.distanceMetric"
|
|
},
|
|
"1067": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorIndex.metadataConfiguration"
|
|
},
|
|
"1068": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorIndex.creationTime"
|
|
},
|
|
"1069": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorData"
|
|
},
|
|
"1070": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorData.float32"
|
|
},
|
|
"1071": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorMetadata"
|
|
},
|
|
"1072": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorObject"
|
|
},
|
|
"1073": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorObject.key"
|
|
},
|
|
"1074": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorObject.data"
|
|
},
|
|
"1075": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorObject.metadata"
|
|
},
|
|
"1076": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorMatch"
|
|
},
|
|
"1077": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorMatch.key"
|
|
},
|
|
"1078": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorMatch.data"
|
|
},
|
|
"1079": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorMatch.metadata"
|
|
},
|
|
"1080": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorMatch.distance"
|
|
},
|
|
"1081": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "EncryptionConfiguration"
|
|
},
|
|
"1082": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "EncryptionConfiguration.kmsKeyArn"
|
|
},
|
|
"1083": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "EncryptionConfiguration.sseType"
|
|
},
|
|
"1084": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "MetadataConfiguration"
|
|
},
|
|
"1085": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "MetadataConfiguration.nonFilterableMetadataKeys"
|
|
},
|
|
"1086": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorDataType"
|
|
},
|
|
"1087": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "DistanceMetric"
|
|
},
|
|
"1088": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorFilter"
|
|
},
|
|
"1089": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorBucketsOptions"
|
|
},
|
|
"1090": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorBucketsOptions.prefix"
|
|
},
|
|
"1091": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorBucketsOptions.maxResults"
|
|
},
|
|
"1092": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorBucketsOptions.nextToken"
|
|
},
|
|
"1093": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorBucketsResponse"
|
|
},
|
|
"1094": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorBucketsResponse.vectorBuckets"
|
|
},
|
|
"1095": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1096": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "__type.vectorBucketName"
|
|
},
|
|
"1097": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorBucketsResponse.nextToken"
|
|
},
|
|
"1098": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListIndexesOptions"
|
|
},
|
|
"1099": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListIndexesOptions.vectorBucketName"
|
|
},
|
|
"1100": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListIndexesOptions.prefix"
|
|
},
|
|
"1101": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListIndexesOptions.maxResults"
|
|
},
|
|
"1102": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListIndexesOptions.nextToken"
|
|
},
|
|
"1103": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListIndexesResponse"
|
|
},
|
|
"1104": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListIndexesResponse.indexes"
|
|
},
|
|
"1105": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1106": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "__type.indexName"
|
|
},
|
|
"1107": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListIndexesResponse.nextToken"
|
|
},
|
|
"1108": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "PutVectorsOptions"
|
|
},
|
|
"1109": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "PutVectorsOptions.vectorBucketName"
|
|
},
|
|
"1110": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "PutVectorsOptions.indexName"
|
|
},
|
|
"1111": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "PutVectorsOptions.vectors"
|
|
},
|
|
"1112": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "GetVectorsOptions"
|
|
},
|
|
"1113": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "GetVectorsOptions.vectorBucketName"
|
|
},
|
|
"1114": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "GetVectorsOptions.indexName"
|
|
},
|
|
"1115": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "GetVectorsOptions.keys"
|
|
},
|
|
"1116": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "GetVectorsOptions.returnData"
|
|
},
|
|
"1117": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "GetVectorsOptions.returnMetadata"
|
|
},
|
|
"1118": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "GetVectorsResponse"
|
|
},
|
|
"1119": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "GetVectorsResponse.vectors"
|
|
},
|
|
"1120": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "DeleteVectorsOptions"
|
|
},
|
|
"1121": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "DeleteVectorsOptions.vectorBucketName"
|
|
},
|
|
"1122": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "DeleteVectorsOptions.indexName"
|
|
},
|
|
"1123": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "DeleteVectorsOptions.keys"
|
|
},
|
|
"1124": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsOptions"
|
|
},
|
|
"1125": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.vectorBucketName"
|
|
},
|
|
"1126": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.indexName"
|
|
},
|
|
"1127": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.maxResults"
|
|
},
|
|
"1128": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.nextToken"
|
|
},
|
|
"1129": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.returnData"
|
|
},
|
|
"1130": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.returnMetadata"
|
|
},
|
|
"1131": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.segmentCount"
|
|
},
|
|
"1132": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsOptions.segmentIndex"
|
|
},
|
|
"1133": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsResponse"
|
|
},
|
|
"1134": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsResponse.vectors"
|
|
},
|
|
"1135": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ListVectorsResponse.nextToken"
|
|
},
|
|
"1136": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions"
|
|
},
|
|
"1137": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.vectorBucketName"
|
|
},
|
|
"1138": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.indexName"
|
|
},
|
|
"1139": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.queryVector"
|
|
},
|
|
"1140": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.topK"
|
|
},
|
|
"1141": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.filter"
|
|
},
|
|
"1142": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.returnDistance"
|
|
},
|
|
"1143": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "QueryVectorsOptions.returnMetadata"
|
|
},
|
|
"1144": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "QueryVectorsResponse"
|
|
},
|
|
"1145": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "QueryVectorsResponse.vectors"
|
|
},
|
|
"1146": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "QueryVectorsResponse.distanceMetric"
|
|
},
|
|
"1147": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ApiResponse"
|
|
},
|
|
"1148": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "T"
|
|
},
|
|
"1149": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "SuccessResponse"
|
|
},
|
|
"1150": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "SuccessResponse.data"
|
|
},
|
|
"1151": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "SuccessResponse.error"
|
|
},
|
|
"1152": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "SuccessResponse.T"
|
|
},
|
|
"1153": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ErrorResponse"
|
|
},
|
|
"1154": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ErrorResponse.data"
|
|
},
|
|
"1155": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "ErrorResponse.error"
|
|
},
|
|
"1156": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorFetchParameters"
|
|
},
|
|
"1157": {
|
|
"sourceFileName": "src/lib/vectors/types.ts",
|
|
"qualifiedName": "VectorFetchParameters.signal"
|
|
},
|
|
"1158": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsError"
|
|
},
|
|
"1159": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsError.__constructor"
|
|
},
|
|
"1160": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsError"
|
|
},
|
|
"1161": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"1163": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsApiError"
|
|
},
|
|
"1164": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsApiError.__constructor"
|
|
},
|
|
"1165": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsApiError"
|
|
},
|
|
"1166": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"1167": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "status"
|
|
},
|
|
"1168": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "statusCode"
|
|
},
|
|
"1169": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsApiError.status"
|
|
},
|
|
"1170": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsApiError.statusCode"
|
|
},
|
|
"1171": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsApiError.toJSON"
|
|
},
|
|
"1172": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsApiError.toJSON"
|
|
},
|
|
"1173": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "__object"
|
|
},
|
|
"1174": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "__object.name"
|
|
},
|
|
"1175": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "__object.message"
|
|
},
|
|
"1176": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "__object.status"
|
|
},
|
|
"1177": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "__object.statusCode"
|
|
},
|
|
"1179": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsUnknownError"
|
|
},
|
|
"1180": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsUnknownError.__constructor"
|
|
},
|
|
"1181": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsUnknownError"
|
|
},
|
|
"1182": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "message"
|
|
},
|
|
"1183": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "originalError"
|
|
},
|
|
"1184": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsUnknownError.originalError"
|
|
},
|
|
"1186": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode"
|
|
},
|
|
"1187": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode.InternalError"
|
|
},
|
|
"1188": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode.S3VectorConflictException"
|
|
},
|
|
"1189": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode.S3VectorNotFoundException"
|
|
},
|
|
"1190": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode.S3VectorBucketNotEmpty"
|
|
},
|
|
"1191": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode.S3VectorMaxBucketsExceeded"
|
|
},
|
|
"1192": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "StorageVectorsErrorCode.S3VectorMaxIndexesExceeded"
|
|
},
|
|
"1193": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "isStorageVectorsError"
|
|
},
|
|
"1194": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "isStorageVectorsError"
|
|
},
|
|
"1195": {
|
|
"sourceFileName": "src/lib/vectors/errors.ts",
|
|
"qualifiedName": "error"
|
|
},
|
|
"1196": {
|
|
"sourceFileName": "src/lib/vectors/fetch.ts",
|
|
"qualifiedName": "Fetch"
|
|
},
|
|
"1197": {
|
|
"sourceFileName": "src/lib/vectors/fetch.ts",
|
|
"qualifiedName": "FetchOptions"
|
|
},
|
|
"1198": {
|
|
"sourceFileName": "src/lib/vectors/fetch.ts",
|
|
"qualifiedName": "FetchOptions.headers"
|
|
},
|
|
"1199": {
|
|
"sourceFileName": "src/lib/vectors/fetch.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1200": {
|
|
"sourceFileName": "src/lib/vectors/fetch.ts",
|
|
"qualifiedName": "__type.__index"
|
|
},
|
|
"1202": {
|
|
"sourceFileName": "src/lib/vectors/fetch.ts",
|
|
"qualifiedName": "FetchOptions.noResolveJson"
|
|
},
|
|
"1203": {
|
|
"sourceFileName": "src/lib/vectors/fetch.ts",
|
|
"qualifiedName": "RequestMethodType"
|
|
},
|
|
"1204": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "resolveFetch"
|
|
},
|
|
"1205": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "resolveFetch"
|
|
},
|
|
"1206": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "customFetch"
|
|
},
|
|
"1207": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"1208": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"1209": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"1210": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"1211": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"1212": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"1213": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"1214": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"1215": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"1216": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"1217": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"1218": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"1219": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"1220": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"1221": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "resolveResponse"
|
|
},
|
|
"1222": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "resolveResponse"
|
|
},
|
|
"1223": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1224": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1225": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "body"
|
|
},
|
|
"1226": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"1227": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "isPlainObject"
|
|
},
|
|
"1228": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "isPlainObject"
|
|
},
|
|
"1229": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"1230": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "normalizeToFloat32"
|
|
},
|
|
"1231": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "normalizeToFloat32"
|
|
},
|
|
"1232": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "values"
|
|
},
|
|
"1233": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "validateVectorDimension"
|
|
},
|
|
"1234": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "validateVectorDimension"
|
|
},
|
|
"1235": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "vector"
|
|
},
|
|
"1236": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"1237": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "__type.float32"
|
|
},
|
|
"1238": {
|
|
"sourceFileName": "src/lib/vectors/helpers.ts",
|
|
"qualifiedName": "expectedDimension"
|
|
}
|
|
},
|
|
"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/StreamDownloadBuilder.ts",
|
|
"7": "../../../CONTRIBUTING.md"
|
|
},
|
|
"reflections": {
|
|
"1": 1,
|
|
"2": 2,
|
|
"3": 46,
|
|
"4": 118,
|
|
"5": 226,
|
|
"6": 478
|
|
}
|
|
}
|
|
}
|