PublicArchive/supabase
2
0
Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-05-06 08:56:46 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
129b3d927a7358c38871cc3f2958f96ea8a539e1
supabase/apps/docs/spec/enrichments/tsdoc_v2/storage_dereferenced.json
T
Kevin Grüneberg 129b3d927a chore: move specs to docs folder (#20136)
2024-01-03 18:54:23 +01:00

9326 lines
370 KiB
JSON
Raw Blame History

{
"id": 0,
"name": "@supabase/storage-js",
"kind": 1,
"flags": {},
"originalName": "",
"children": [
{
"id": 1,
"name": "index",
"kind": 2,
"kindString": "Module",
"flags": {},
"children": [
{
"id": 445,
"name": "StorageApiError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 446,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 17,
"character": 2
}
],
"signatures": [
{
"id": 447,
"name": "new StorageApiError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 448,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 449,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"id": 445,
"name": "StorageApiError"
},
"overwrites": {
"type": "reference",
"id": 442,
"name": "StorageError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 441,
"name": "StorageError.constructor"
}
},
{
"id": 450,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 15,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 451,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 23,
"character": 2
}
],
"signatures": [
{
"id": 452,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 453,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 455,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 26,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 454,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 25,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 456,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 27,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "..."
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
455,
454,
456
]
}
]
}
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
446
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
450
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
451
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 14,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 440,
"name": "StorageError"
}
]
},
{
"id": 300,
"name": "StorageClient",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 301,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/StorageClient.ts",
"line": 6,
"character": 2
}
],
"signatures": [
{
"id": 302,
"name": "new StorageClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 303,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 304,
"name": "headers",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 305,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 306,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 307,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
},
"defaultValue": "{}"
},
{
"id": 308,
"name": "fetch",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 309,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 310,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 311,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
}
},
{
"id": 312,
"name": "init",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"qualifiedName": "RequestInit",
"package": "typescript",
"name": "RequestInit"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Response",
"package": "typescript",
"name": "Response"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 300,
"name": "StorageClient"
},
"overwrites": {
"type": "reference",
"id": 5,
"name": "default.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 4,
"name": "default.constructor"
}
},
{
"id": 343,
"name": "createBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 85,
"character": 8
}
],
"signatures": [
{
"id": 344,
"name": "createBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates a new Storage bucket",
"returns": "newly created bucket id\n"
},
"parameters": [
{
"id": 345,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A unique identifier for the bucket you are creating."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 346,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 347,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 350,
"name": "allowedMimeTypes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/packages/StorageBucketApi.ts",
"line": 90,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
]
}
},
{
"id": 349,
"name": "fileSizeLimit",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/packages/StorageBucketApi.ts",
"line": 89,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 348,
"name": "public",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "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": "src/packages/StorageBucketApi.ts",
"line": 88,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
350,
349,
348
]
}
]
}
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 351,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 352,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 96,
"character": 8
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 395,
"name": "Bucket"
},
{
"type": "literal",
"value": "name"
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
},
{
"id": 353,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 97,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
352,
353
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 354,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 355,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 100,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 356,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 101,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
355,
356
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 44,
"name": "default.createBucket"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 43,
"name": "default.createBucket"
}
},
{
"id": 384,
"name": "deleteBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 219,
"character": 8
}
],
"signatures": [
{
"id": 385,
"name": "deleteBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket."
},
"parameters": [
{
"id": 386,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The unique identifier of the bucket you would like to delete.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 387,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 388,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 223,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 389,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 390,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 223,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
390
]
}
]
}
}
},
{
"id": 391,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 224,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
388,
391
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 392,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 393,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 227,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 394,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 228,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
393,
394
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 85,
"name": "default.deleteBucket"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 84,
"name": "default.deleteBucket"
}
},
{
"id": 373,
"name": "emptyBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 184,
"character": 8
}
],
"signatures": [
{
"id": 374,
"name": "emptyBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Removes all objects inside a single bucket."
},
"parameters": [
{
"id": 375,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The unique identifier of the bucket you would like to empty.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 376,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 377,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 188,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 378,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 379,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 188,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
379
]
}
]
}
}
},
{
"id": 380,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 189,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
377,
380
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 381,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 382,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 192,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 383,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 193,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
382,
383
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 74,
"name": "default.emptyBucket"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 73,
"name": "default.emptyBucket"
}
},
{
"id": 313,
"name": "from",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/StorageClient.ts",
"line": 15,
"character": 2
}
],
"signatures": [
{
"id": 314,
"name": "from",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Perform file operation in a bucket."
},
"parameters": [
{
"id": 315,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The bucket id to operate on.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 96,
"name": "default"
}
}
]
},
{
"id": 334,
"name": "getBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 48,
"character": 8
}
],
"signatures": [
{
"id": 335,
"name": "getBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Retrieves the details of an existing Storage bucket."
},
"parameters": [
{
"id": 336,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The unique identifier of the bucket you would like to retrieve.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 337,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 338,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 52,
"character": 8
}
],
"type": {
"type": "reference",
"id": 395,
"name": "Bucket"
}
},
{
"id": 339,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 53,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
338,
339
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 340,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 341,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 56,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 342,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 57,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
341,
342
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 35,
"name": "default.getBucket"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 34,
"name": "default.getBucket"
}
},
{
"id": 326,
"name": "listBuckets",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 21,
"character": 8
}
],
"signatures": [
{
"id": 327,
"name": "listBuckets",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Retrieves the details of all Storage buckets within an existing project."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 328,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 329,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 23,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 395,
"name": "Bucket"
}
}
},
{
"id": 330,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 24,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
329,
330
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 331,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 332,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 333,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
332,
333
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 27,
"name": "default.listBuckets"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 26,
"name": "default.listBuckets"
}
},
{
"id": 357,
"name": "updateBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 139,
"character": 8
}
],
"signatures": [
{
"id": 358,
"name": "updateBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates a Storage bucket"
},
"parameters": [
{
"id": 359,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A unique identifier for the bucket you are updating."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 360,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 361,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 364,
"name": "allowedMimeTypes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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.\n"
},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 144,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
]
}
},
{
"id": 363,
"name": "fileSizeLimit",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/packages/StorageBucketApi.ts",
"line": 143,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 362,
"name": "public",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "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": "src/packages/StorageBucketApi.ts",
"line": 142,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
364,
363,
362
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 365,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 366,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 148,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 367,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 368,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 148,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
368
]
}
]
}
}
},
{
"id": 369,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 149,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
366,
369
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 370,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 371,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 152,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 372,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 153,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
371,
372
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 58,
"name": "default.updateBucket"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 57,
"name": "default.updateBucket"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
301
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
343,
384,
373,
313,
334,
326,
357
]
}
],
"sources": [
{
"fileName": "src/StorageClient.ts",
"line": 5,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 3,
"name": "default"
}
]
},
{
"id": 440,
"name": "StorageError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 441,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 4,
"character": 2
}
],
"signatures": [
{
"id": 442,
"name": "new StorageError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 443,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
},
"overwrites": {
"type": "reference",
"name": "Error.constructor"
}
}
],
"overwrites": {
"type": "reference",
"name": "Error.constructor"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
441
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 1,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"qualifiedName": "Error",
"package": "typescript",
"name": "Error"
}
],
"extendedBy": [
{
"type": "reference",
"id": 445,
"name": "StorageApiError"
},
{
"type": "reference",
"id": 458,
"name": "StorageUnknownError"
}
]
},
{
"id": 458,
"name": "StorageUnknownError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 459,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 35,
"character": 2
}
],
"signatures": [
{
"id": 460,
"name": "new StorageUnknownError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 461,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 462,
"name": "originalError",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "reference",
"id": 458,
"name": "StorageUnknownError"
},
"overwrites": {
"type": "reference",
"id": 442,
"name": "StorageError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 441,
"name": "StorageError.constructor"
}
},
{
"id": 463,
"name": "originalError",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 33,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
459
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
463
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 32,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 440,
"name": "StorageError"
}
]
},
{
"id": 395,
"name": "Bucket",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 400,
"name": "allowed_mime_types",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 6,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
},
{
"id": 401,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 7,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 399,
"name": "file_size_limit",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 5,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 396,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 2,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 397,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 3,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 398,
"name": "owner",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 4,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 403,
"name": "public",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 9,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 402,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 8,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
400,
401,
399,
396,
397,
398,
403,
402
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1,
"character": 17
}
]
},
{
"id": 427,
"name": "FetchParameters",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 428,
"name": "signal",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Pass in an AbortController's signal to cancel the request."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 74,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "AbortSignal",
"package": "typescript",
"name": "AbortSignal"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
428
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 70,
"character": 17
}
]
},
{
"id": 404,
"name": "FileObject",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 406,
"name": "bucket_id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 14,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 413,
"name": "buckets",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 21,
"character": 2
}
],
"type": {
"type": "reference",
"id": 395,
"name": "Bucket",
"dereferenced": {
"id": 395,
"name": "Bucket",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 400,
"name": "allowed_mime_types",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 6,
"character": 2
}
],
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
},
{
"id": 401,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 7,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 399,
"name": "file_size_limit",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 5,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 396,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 2,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 397,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 3,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 398,
"name": "owner",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 4,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 403,
"name": "public",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 9,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 402,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 8,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
400,
401,
399,
396,
397,
398,
403,
402
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1,
"character": 17
}
]
}
}
},
{
"id": 410,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 18,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 408,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 16,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 411,
"name": "last_accessed_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 19,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 412,
"name": "metadata",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 20,
"character": 2
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "any"
}
],
"qualifiedName": "Record",
"package": "typescript",
"name": "Record"
}
},
{
"id": 405,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 13,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 407,
"name": "owner",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 15,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 409,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 17,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
406,
413,
410,
408,
411,
412,
405,
407,
409
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 12,
"character": 17
}
]
},
{
"id": 417,
"name": "FileOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 418,
"name": "cacheControl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=<seconds>` header. Defaults to 3600 seconds."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 33,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 419,
"name": "contentType",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 37,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 421,
"name": "duplex",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 45,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 420,
"name": "upsert",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 41,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
418,
419,
421,
420
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 29,
"character": 17
}
]
},
{
"id": 429,
"name": "Metadata",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 430,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 79,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
430
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 78,
"character": 17
}
]
},
{
"id": 422,
"name": "SearchOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 423,
"name": "limit",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": " The number of files you want to be returned."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 52,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 424,
"name": "offset",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The starting position."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 57,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 426,
"name": "search",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The search string to filter files by."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 67,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 425,
"name": "sortBy",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The column to sort by. Can be any column inside a FileObject."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 62,
"character": 2
}
],
"type": {
"type": "reference",
"id": 414,
"name": "SortBy",
"dereferenced": {
"id": 414,
"name": "SortBy",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 415,
"name": "column",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 25,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 416,
"name": "order",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 26,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
415,
416
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 24,
"character": 17
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
423,
424,
426,
425
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 48,
"character": 17
}
]
},
{
"id": 414,
"name": "SortBy",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 415,
"name": "column",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 25,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 416,
"name": "order",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 26,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
415,
416
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 24,
"character": 17
}
]
},
{
"id": 431,
"name": "TransformOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 436,
"name": "format",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Specify the format of the image requested.",
"text": "When 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.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 110,
"character": 2
}
],
"type": {
"type": "literal",
"value": "origin"
}
},
{
"id": 433,
"name": "height",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The height of the image in pixels."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 90,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 435,
"name": "quality",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 103,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 434,
"name": "resize",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 97,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "cover"
},
{
"type": "literal",
"value": "contain"
},
{
"type": "literal",
"value": "fill"
}
]
}
},
{
"id": 432,
"name": "width",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The width of the image in pixels."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 86,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
436,
433,
435,
434,
432
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 82,
"character": 17
}
]
},
{
"id": 437,
"name": "isStorageError",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 10,
"character": 16
}
],
"signatures": [
{
"id": 438,
"name": "isStorageError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 439,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "predicate",
"name": "error",
"asserts": false,
"targetType": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
445,
300,
440,
458
]
},
{
"title": "Interfaces",
"kind": 256,
"children": [
395,
427,
404,
417,
429,
422,
414,
431
]
},
{
"title": "Functions",
"kind": 64,
"children": [
437
]
}
],
"sources": [
{
"fileName": "src/index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 2,
"name": "packages/StorageBucketApi",
"kind": 2,
"kindString": "Module",
"flags": {},
"children": [
{
"id": 3,
"name": "default",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 4,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 12,
"character": 2
}
],
"signatures": [
{
"id": 5,
"name": "new default",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 6,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 7,
"name": "headers",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 8,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 9,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 10,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
},
"defaultValue": "{}"
},
{
"id": 11,
"name": "fetch",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 12,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 13,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 14,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
}
},
{
"id": 15,
"name": "init",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"qualifiedName": "RequestInit",
"package": "typescript",
"name": "RequestInit"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Response",
"package": "typescript",
"name": "Response"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 3,
"name": "default"
}
}
]
},
{
"id": 43,
"name": "createBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 85,
"character": 8
}
],
"signatures": [
{
"id": 44,
"name": "createBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates a new Storage bucket",
"returns": "newly created bucket id\n"
},
"parameters": [
{
"id": 45,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A unique identifier for the bucket you are creating."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 46,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 47,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 50,
"name": "allowedMimeTypes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/packages/StorageBucketApi.ts",
"line": 90,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
]
}
},
{
"id": 49,
"name": "fileSizeLimit",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/packages/StorageBucketApi.ts",
"line": 89,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 48,
"name": "public",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "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": "src/packages/StorageBucketApi.ts",
"line": 88,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
50,
49,
48
]
}
]
}
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 51,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 52,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 96,
"character": 8
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 395,
"name": "Bucket"
},
{
"type": "literal",
"value": "name"
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
},
{
"id": 53,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 97,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
52,
53
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 54,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 55,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 100,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 56,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 101,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
55,
56
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 84,
"name": "deleteBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 219,
"character": 8
}
],
"signatures": [
{
"id": 85,
"name": "deleteBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Deletes an existing bucket. A bucket can't be deleted with existing objects inside it.\nYou must first `empty()` the bucket."
},
"parameters": [
{
"id": 86,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The unique identifier of the bucket you would like to delete.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 87,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 88,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 223,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 89,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 90,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 223,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
90
]
}
]
}
}
},
{
"id": 91,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 224,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
88,
91
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 92,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 93,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 227,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 94,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 228,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
93,
94
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 73,
"name": "emptyBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 184,
"character": 8
}
],
"signatures": [
{
"id": 74,
"name": "emptyBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Removes all objects inside a single bucket."
},
"parameters": [
{
"id": 75,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The unique identifier of the bucket you would like to empty.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 76,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 77,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 188,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 78,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 79,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 188,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
79
]
}
]
}
}
},
{
"id": 80,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 189,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
77,
80
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 81,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 82,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 192,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 83,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 193,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
82,
83
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 34,
"name": "getBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 48,
"character": 8
}
],
"signatures": [
{
"id": 35,
"name": "getBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Retrieves the details of an existing Storage bucket."
},
"parameters": [
{
"id": 36,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The unique identifier of the bucket you would like to retrieve.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 37,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 38,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 52,
"character": 8
}
],
"type": {
"type": "reference",
"id": 395,
"name": "Bucket"
}
},
{
"id": 39,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 53,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
38,
39
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 40,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 41,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 56,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 42,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 57,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
41,
42
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 26,
"name": "listBuckets",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 21,
"character": 8
}
],
"signatures": [
{
"id": 27,
"name": "listBuckets",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Retrieves the details of all Storage buckets within an existing project."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 28,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 29,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 23,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 395,
"name": "Bucket"
}
}
},
{
"id": 30,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 24,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
29,
30
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 31,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 32,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 33,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
32,
33
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 57,
"name": "updateBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 139,
"character": 8
}
],
"signatures": [
{
"id": 58,
"name": "updateBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates a Storage bucket"
},
"parameters": [
{
"id": 59,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A unique identifier for the bucket you are updating."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 60,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 61,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 64,
"name": "allowedMimeTypes",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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.\n"
},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 144,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
]
}
},
{
"id": 63,
"name": "fileSizeLimit",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/packages/StorageBucketApi.ts",
"line": 143,
"character": 6
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 62,
"name": "public",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "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": "src/packages/StorageBucketApi.ts",
"line": 142,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
64,
63,
62
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 65,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 66,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 148,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 67,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 68,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 148,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
68
]
}
]
}
}
},
{
"id": 69,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 149,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
66,
69
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 70,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 71,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 152,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 72,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 153,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
71,
72
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
4
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
43,
84,
73,
34,
26,
57
]
}
],
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 7,
"character": 21
}
],
"extendedBy": [
{
"type": "reference",
"id": 300,
"name": "StorageClient"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
3
]
}
],
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 95,
"name": "packages/StorageFileApi",
"kind": 2,
"kindString": "Module",
"flags": {},
"children": [
{
"id": 96,
"name": "default",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 97,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 45,
"character": 2
}
],
"signatures": [
{
"id": 98,
"name": "new default",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 99,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 100,
"name": "headers",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 101,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 102,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 103,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
},
"defaultValue": "{}"
},
{
"id": 104,
"name": "bucketId",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 105,
"name": "fetch",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 106,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 107,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 108,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
}
},
{
"id": 109,
"name": "init",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"qualifiedName": "RequestInit",
"package": "typescript",
"name": "RequestInit"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Response",
"package": "typescript",
"name": "Response"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
}
}
],
"type": {
"type": "reference",
"id": 96,
"name": "default"
}
}
]
},
{
"id": 203,
"name": "copy",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 338,
"character": 8
}
],
"signatures": [
{
"id": 204,
"name": "copy",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Copies an existing file to a new path in the same bucket."
},
"parameters": [
{
"id": 205,
"name": "fromPath",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The original file path, including the current file name. For example `folder/image.png`."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 206,
"name": "toPath",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The new file path, including the new file name. For example `folder/image-copy.png`.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 207,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 208,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 343,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 209,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 210,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 343,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
210
]
}
]
}
}
},
{
"id": 211,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 344,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
208,
211
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 212,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 213,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 347,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 214,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 348,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
213,
214
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 165,
"name": "createSignedUploadUrl",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 223,
"character": 8
}
],
"signatures": [
{
"id": 166,
"name": "createSignedUploadUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "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."
},
"parameters": [
{
"id": 167,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The file path, including the current file name. For example `folder/image.png`.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 168,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 169,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 227,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 170,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 173,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 227,
"character": 50
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 171,
"name": "signedUrl",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 227,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 172,
"name": "token",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 227,
"character": 35
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
173,
171,
172
]
}
]
}
}
},
{
"id": 174,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 228,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
169,
174
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 175,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 176,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 231,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 177,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 232,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
176,
177
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 215,
"name": "createSignedUrl",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 376,
"character": 8
}
],
"signatures": [
{
"id": 216,
"name": "createSignedUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates a signed URL. Use a signed URL to share a file for a fixed amount of time."
},
"parameters": [
{
"id": 217,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The file path, including the current file name. For example `folder/image.png`."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 218,
"name": "expiresIn",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 219,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 220,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 221,
"name": "download",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/packages/StorageFileApi.ts",
"line": 379,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "boolean"
}
]
}
},
{
"id": 222,
"name": "transform",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Transform the asset before serving it to the client.\n"
},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 379,
"character": 45
}
],
"type": {
"type": "reference",
"id": 431,
"name": "TransformOptions",
"dereferenced": {
"id": 431,
"name": "TransformOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 436,
"name": "format",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Specify the format of the image requested.",
"text": "When 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.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 110,
"character": 2
}
],
"type": {
"type": "literal",
"value": "origin"
}
},
{
"id": 433,
"name": "height",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The height of the image in pixels."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 90,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 435,
"name": "quality",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 103,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 434,
"name": "resize",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 97,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "cover"
},
{
"type": "literal",
"value": "contain"
},
{
"type": "literal",
"value": "fill"
}
]
}
},
{
"id": 432,
"name": "width",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The width of the image in pixels."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 86,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
436,
433,
435,
434,
432
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 82,
"character": 17
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
221,
222
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 223,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 224,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 382,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 225,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 226,
"name": "signedUrl",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 382,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
226
]
}
]
}
}
},
{
"id": 227,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 383,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
224,
227
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 228,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 229,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 386,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 230,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 387,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
229,
230
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 231,
"name": "createSignedUrls",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 421,
"character": 8
}
],
"signatures": [
{
"id": 232,
"name": "createSignedUrls",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates multiple signed URLs. Use a signed URL to share a file for a fixed amount of time."
},
"parameters": [
{
"id": 233,
"name": "paths",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The file paths to be downloaded, including the current file names. For example `['folder/image.png', 'folder2/image2.png']`."
},
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
},
{
"id": 234,
"name": "expiresIn",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The number of seconds until the signed URLs expire. For example, `60` for URLs which are valid for one minute."
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 235,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 236,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 237,
"name": "download",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "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.\n"
},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 424,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "boolean"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
237
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 238,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 239,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 427,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reflection",
"declaration": {
"id": 240,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 241,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 427,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 242,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 427,
"character": 38
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 243,
"name": "signedUrl",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 427,
"character": 59
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
241,
242,
243
]
}
]
}
}
}
},
{
"id": 244,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 428,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
239,
244
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 245,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 246,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 431,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 247,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 432,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
246,
247
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 248,
"name": "download",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 470,
"character": 8
}
],
"signatures": [
{
"id": 249,
"name": "download",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Downloads a file from a private bucket. For public buckets, make a request to the URL returned from `getPublicUrl` instead."
},
"parameters": [
{
"id": 250,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The full path and file name of the file to be downloaded. For example `folder/image.png`."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 251,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 252,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 253,
"name": "transform",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Transform the asset before serving it to the client.\n"
},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 472,
"character": 16
}
],
"type": {
"type": "reference",
"id": 431,
"name": "TransformOptions",
"dereferenced": {
"id": 431,
"name": "TransformOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 436,
"name": "format",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Specify the format of the image requested.",
"text": "When 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.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 110,
"character": 2
}
],
"type": {
"type": "literal",
"value": "origin"
}
},
{
"id": 433,
"name": "height",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The height of the image in pixels."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 90,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 435,
"name": "quality",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 103,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 434,
"name": "resize",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 97,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "cover"
},
{
"type": "literal",
"value": "contain"
},
{
"type": "literal",
"value": "fill"
}
]
}
},
{
"id": 432,
"name": "width",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The width of the image in pixels."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 86,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
436,
433,
435,
434,
432
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 82,
"character": 17
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
253
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 254,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 255,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 475,
"character": 8
}
],
"type": {
"type": "reference",
"qualifiedName": "Blob",
"package": "typescript",
"name": "Blob"
}
},
{
"id": 256,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 476,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
255,
256
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 257,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 258,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 479,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 259,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 480,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
258,
259
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 260,
"name": "getPublicUrl",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 513,
"character": 2
}
],
"signatures": [
{
"id": 261,
"name": "getPublicUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "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."
},
"parameters": [
{
"id": 262,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The path and name of the file to generate the public URL for. For example `folder/image.png`."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 263,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 264,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 265,
"name": "download",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/packages/StorageFileApi.ts",
"line": 515,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "boolean"
}
]
}
},
{
"id": 266,
"name": "transform",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Transform the asset before serving it to the client.\n"
},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 515,
"character": 45
}
],
"type": {
"type": "reference",
"id": 431,
"name": "TransformOptions",
"dereferenced": {
"id": 431,
"name": "TransformOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 436,
"name": "format",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Specify the format of the image requested.",
"text": "When 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.\n"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 110,
"character": 2
}
],
"type": {
"type": "literal",
"value": "origin"
}
},
{
"id": 433,
"name": "height",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The height of the image in pixels."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 90,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 435,
"name": "quality",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Set the quality of the returned image.\nA number from 20 to 100, with 100 being the highest quality.\nDefaults to 80"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 103,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 434,
"name": "resize",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 97,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "cover"
},
{
"type": "literal",
"value": "contain"
},
{
"type": "literal",
"value": "fill"
}
]
}
},
{
"id": 432,
"name": "width",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The width of the image in pixels."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 86,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
436,
433,
435,
434,
432
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 82,
"character": 17
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
265,
266
]
}
]
}
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 267,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 268,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 516,
"character": 7
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 269,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 270,
"name": "publicUrl",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 516,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
270
]
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
268
]
}
]
}
}
}
]
},
{
"id": 280,
"name": "list",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 647,
"character": 8
}
],
"signatures": [
{
"id": 281,
"name": "list",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Lists all the files within a bucket."
},
"parameters": [
{
"id": 282,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The folder path.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 283,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 422,
"name": "SearchOptions",
"dereferenced": {
"id": 422,
"name": "SearchOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 423,
"name": "limit",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": " The number of files you want to be returned."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 52,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 424,
"name": "offset",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The starting position."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 57,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 426,
"name": "search",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The search string to filter files by."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 67,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 425,
"name": "sortBy",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The column to sort by. Can be any column inside a FileObject."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 62,
"character": 2
}
],
"type": {
"type": "reference",
"id": 414,
"name": "SortBy",
"dereferenced": {
"id": 414,
"name": "SortBy",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 415,
"name": "column",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 25,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 416,
"name": "order",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 26,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
415,
416
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 24,
"character": 17
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
423,
424,
426,
425
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 48,
"character": 17
}
]
}
}
},
{
"id": 284,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 427,
"name": "FetchParameters",
"dereferenced": {
"id": 427,
"name": "FetchParameters",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 428,
"name": "signal",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Pass in an AbortController's signal to cancel the request."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 74,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "AbortSignal",
"package": "typescript",
"name": "AbortSignal"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
428
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 70,
"character": 17
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 285,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 286,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 653,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 404,
"name": "FileObject"
}
}
},
{
"id": 287,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 654,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
286,
287
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 288,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 289,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 657,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 290,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 658,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
289,
290
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 191,
"name": "move",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 302,
"character": 8
}
],
"signatures": [
{
"id": 192,
"name": "move",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Moves an existing file to a new path in the same bucket."
},
"parameters": [
{
"id": 193,
"name": "fromPath",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The original file path, including the current file name. For example `folder/image.png`."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 194,
"name": "toPath",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The new file path, including the new file name. For example `folder/image-new.png`.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 195,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 196,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 307,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 197,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 198,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 307,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
198
]
}
]
}
}
},
{
"id": 199,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 308,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
196,
199
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 200,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 201,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 311,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 202,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 312,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
201,
202
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 271,
"name": "remove",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 551,
"character": 8
}
],
"signatures": [
{
"id": 272,
"name": "remove",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Deletes files within the same bucket"
},
"parameters": [
{
"id": 273,
"name": "paths",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "An array of files to delete, including the path and file name. For example [`'folder/image.png'`].\n"
},
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "string"
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 274,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 275,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 555,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 404,
"name": "FileObject"
}
}
},
{
"id": 276,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 556,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
275,
276
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 277,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 278,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 559,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 279,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 560,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
278,
279
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 178,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 269,
"character": 8
}
],
"signatures": [
{
"id": 179,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Replaces an existing file at the specified path with a new one."
},
"parameters": [
{
"id": 180,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The relative file path. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to update."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 181,
"name": "fileBody",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The body of the file to be stored in the bucket.\n"
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "reference",
"qualifiedName": "ArrayBuffer",
"package": "typescript",
"name": "ArrayBuffer"
},
{
"type": "reference",
"qualifiedName": "ArrayBufferView",
"package": "typescript",
"name": "ArrayBufferView"
},
{
"type": "reference",
"qualifiedName": "Blob",
"package": "typescript",
"name": "Blob"
},
{
"type": "reference",
"qualifiedName": "Buffer",
"package": "@types/node",
"name": "Buffer"
},
{
"type": "reference",
"qualifiedName": "File",
"package": "typescript",
"name": "File"
},
{
"type": "reference",
"qualifiedName": "FormData",
"package": "typescript",
"name": "FormData"
},
{
"type": "reference",
"qualifiedName": "NodeJS.ReadableStream",
"package": "@types/node",
"name": "ReadableStream"
},
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Uint8Array",
"package": "typescript",
"name": "Uint8Array"
}
],
"qualifiedName": "ReadableStream",
"package": "typescript",
"name": "ReadableStream"
},
{
"type": "reference",
"qualifiedName": "URLSearchParams",
"package": "typescript",
"name": "URLSearchParams"
}
]
}
},
{
"id": 182,
"name": "fileOptions",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 417,
"name": "FileOptions",
"dereferenced": {
"id": 417,
"name": "FileOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 418,
"name": "cacheControl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=<seconds>` header. Defaults to 3600 seconds."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 33,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 419,
"name": "contentType",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 37,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 421,
"name": "duplex",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 45,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 420,
"name": "upsert",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 41,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
418,
419,
421,
420
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 29,
"character": 17
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 183,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 184,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 285,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 185,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 186,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 285,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
186
]
}
]
}
}
},
{
"id": 187,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 286,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
184,
187
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 188,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 189,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 289,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 190,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 290,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
189,
190
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 137,
"name": "upload",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 135,
"character": 8
}
],
"signatures": [
{
"id": 138,
"name": "upload",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Uploads a file to an existing bucket."
},
"parameters": [
{
"id": 139,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 140,
"name": "fileBody",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The body of the file to be stored in the bucket.\n"
},
"type": {
"type": "reference",
"name": "FileBody"
}
},
{
"id": 141,
"name": "fileOptions",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 417,
"name": "FileOptions",
"dereferenced": {
"id": 417,
"name": "FileOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 418,
"name": "cacheControl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=<seconds>` header. Defaults to 3600 seconds."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 33,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 419,
"name": "contentType",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 37,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 421,
"name": "duplex",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 45,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 420,
"name": "upsert",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 41,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
418,
419,
421,
420
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 29,
"character": 17
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 142,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 143,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 141,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 144,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 145,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 141,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
145
]
}
]
}
}
},
{
"id": 146,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 142,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
143,
146
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 147,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 148,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 145,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 149,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 146,
"character": 8
}
],
"type": {
"type": "reference",
"id": 440,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
148,
149
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 150,
"name": "uploadToSignedUrl",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 158,
"character": 8
}
],
"signatures": [
{
"id": 151,
"name": "uploadToSignedUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Upload a file with a token generated from `createSignedUploadUrl`."
},
"parameters": [
{
"id": 152,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The file path, including the file name. Should be of the format `folder/subfolder/filename.png`. The bucket must already exist before attempting to upload."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 153,
"name": "token",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The token generated from `createSignedUploadUrl`"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 154,
"name": "fileBody",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The body of the file to be stored in the bucket.\n"
},
"type": {
"type": "reference",
"name": "FileBody"
}
},
{
"id": 155,
"name": "fileOptions",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 417,
"name": "FileOptions",
"dereferenced": {
"id": 417,
"name": "FileOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 418,
"name": "cacheControl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The number of seconds the asset is cached in the browser and in the Supabase CDN. This is set in the `Cache-Control: max-age=<seconds>` header. Defaults to 3600 seconds."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 33,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 419,
"name": "contentType",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "the `Content-Type` header value. Should be specified if using a `fileBody` that is neither `Blob` nor `File` nor `FormData`, otherwise will default to `text/plain;charset=UTF-8`."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 37,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 421,
"name": "duplex",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 45,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 420,
"name": "upsert",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "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": "src/lib/types.ts",
"line": 41,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
418,
419,
421,
420
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 29,
"character": 17
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 156,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 157,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 201,
"character": 10
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 158,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 160,
"name": "fullPath",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 201,
"character": 35
}
],
"type": {
"type": "intrinsic",
"name": "any"
},
"defaultValue": "data.Key"
},
{
"id": 159,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 201,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "cleanPath"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
160,
159
]
}
]
}
},
"defaultValue": "..."
},
{
"id": 161,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 202,
"character": 10
}
],
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
157,
161
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 162,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 163,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 206,
"character": 17
}
],
"type": {
"type": "literal",
"value": null
},
"defaultValue": "null"
},
{
"id": 164,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
163,
164
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
97
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
203,
165,
215,
231,
248,
260,
280,
191,
271,
178,
137,
150
]
}
],
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 39,
"character": 21
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
96
]
}
],
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 2,
"children": [
1,
2,
95
]
}
]
}
Reference in New Issue View Git Blame Copy Permalink