lywsvip/supabase
1
0
Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-07-06 16:44:19 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
f115a6e53a26d50488c94de5b55fc3a01f3cfbca
supabase/web/spec/tsdoc_v2/storage.json
Inian 7c37f037b8 update storage docs
2022-08-16 12:27:41 +08:00

6753 lines
170 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": 381,
"name": "StorageApiError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 382,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 17,
"character": 2
}
],
"signatures": [
{
"id": 383,
"name": "new StorageApiError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 384,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 385,
"name": "status",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"id": 381,
"name": "StorageApiError"
},
"overwrites": {
"type": "reference",
"id": 378,
"name": "StorageError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 377,
"name": "StorageError.constructor"
}
},
{
"id": 386,
"name": "status",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 15,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 387,
"name": "toJSON",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 23,
"character": 2
}
],
"signatures": [
{
"id": 388,
"name": "toJSON",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 389,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 391,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 26,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 390,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 25,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "..."
},
{
"id": 392,
"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": [
391,
390,
392
]
}
]
}
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
382
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
386
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
387
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 14,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 376,
"name": "StorageError"
}
]
},
{
"id": 249,
"name": "StorageClient",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 250,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/StorageClient.ts",
"line": 6,
"character": 2
}
],
"signatures": [
{
"id": 251,
"name": "new StorageClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 252,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 253,
"name": "headers",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 254,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 255,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 256,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
},
"defaultValue": "{}"
},
{
"id": 257,
"name": "fetch",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 258,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 259,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 260,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
}
},
{
"id": 261,
"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": 249,
"name": "StorageClient"
},
"overwrites": {
"type": "reference",
"id": 5,
"name": "default.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 4,
"name": "default.constructor"
}
},
{
"id": 292,
"name": "createBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 79,
"character": 8
}
],
"signatures": [
{
"id": 293,
"name": "createBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Creates a new Storage bucket",
"returns": "newly created bucket id\n"
},
"parameters": [
{
"id": 294,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A unique identifier for the bucket you are creating."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 295,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 296,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 297,
"name": "public",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The visibility of the bucket. By default, buckets are not public."
},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 81,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
297
]
}
]
}
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 298,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 299,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 84,
"character": 8
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 340,
"name": "Bucket"
},
{
"type": "literal",
"value": "name"
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
},
{
"id": 300,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 85,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
299,
300
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 301,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 302,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 88,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 303,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 89,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
302,
303
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 44,
"name": "default.createBucket"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 43,
"name": "default.createBucket"
}
},
{
"id": 329,
"name": "deleteBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 185,
"character": 8
}
],
"signatures": [
{
"id": 330,
"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": 331,
"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": 332,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 333,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 189,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 334,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 335,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 189,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
335
]
}
]
}
}
},
{
"id": 336,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 190,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
333,
336
]
}
]
}
},
{
"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": 193,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 339,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 194,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
338,
339
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 81,
"name": "default.deleteBucket"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 80,
"name": "default.deleteBucket"
}
},
{
"id": 318,
"name": "emptyBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 150,
"character": 8
}
],
"signatures": [
{
"id": 319,
"name": "emptyBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Removes all objects inside a single bucket."
},
"parameters": [
{
"id": 320,
"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": 321,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 322,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 154,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 323,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 324,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 154,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
324
]
}
]
}
}
},
{
"id": 325,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 155,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
322,
325
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 326,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 327,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 158,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 328,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 159,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
327,
328
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 70,
"name": "default.emptyBucket"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 69,
"name": "default.emptyBucket"
}
},
{
"id": 262,
"name": "from",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/StorageClient.ts",
"line": 15,
"character": 2
}
],
"signatures": [
{
"id": 263,
"name": "from",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Perform file operation in a bucket."
},
"parameters": [
{
"id": 264,
"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": 92,
"name": "default"
}
}
]
},
{
"id": 283,
"name": "getBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 48,
"character": 8
}
],
"signatures": [
{
"id": 284,
"name": "getBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Retrieves the details of an existing Storage bucket."
},
"parameters": [
{
"id": 285,
"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": 286,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 287,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 52,
"character": 8
}
],
"type": {
"type": "reference",
"id": 340,
"name": "Bucket"
}
},
{
"id": 288,
"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": [
287,
288
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 289,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 290,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 56,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 291,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 57,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
290,
291
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 35,
"name": "default.getBucket"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 34,
"name": "default.getBucket"
}
},
{
"id": 275,
"name": "listBuckets",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 21,
"character": 8
}
],
"signatures": [
{
"id": 276,
"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": 277,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 278,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 23,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 340,
"name": "Bucket"
}
}
},
{
"id": 279,
"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": [
278,
279
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 280,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 281,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 27,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 282,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 28,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
281,
282
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 27,
"name": "default.listBuckets"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 26,
"name": "default.listBuckets"
}
},
{
"id": 304,
"name": "updateBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 115,
"character": 8
}
],
"signatures": [
{
"id": 305,
"name": "updateBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates a new Storage bucket"
},
"parameters": [
{
"id": 306,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A unique identifier for the bucket you are updating."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 307,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 308,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 309,
"name": "public",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The visibility of the bucket.\n"
},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 117,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
309
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 310,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 311,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 120,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 312,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 313,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 120,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
313
]
}
]
}
}
},
{
"id": 314,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 121,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
311,
314
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 315,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 316,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 124,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 317,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 125,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
316,
317
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 56,
"name": "default.updateBucket"
}
}
],
"inheritedFrom": {
"type": "reference",
"id": 55,
"name": "default.updateBucket"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
250
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
292,
329,
318,
262,
283,
275,
304
]
}
],
"sources": [
{
"fileName": "src/StorageClient.ts",
"line": 5,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 3,
"name": "default"
}
]
},
{
"id": 376,
"name": "StorageError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 377,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 4,
"character": 2
}
],
"signatures": [
{
"id": 378,
"name": "new StorageError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 379,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
},
"overwrites": {
"type": "reference",
"name": "Error.constructor"
}
}
],
"overwrites": {
"type": "reference",
"name": "Error.constructor"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
377
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 1,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"qualifiedName": "Error",
"package": "typescript",
"name": "Error"
}
],
"extendedBy": [
{
"type": "reference",
"id": 381,
"name": "StorageApiError"
},
{
"type": "reference",
"id": 394,
"name": "StorageUnknownError"
}
]
},
{
"id": 394,
"name": "StorageUnknownError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 395,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 35,
"character": 2
}
],
"signatures": [
{
"id": 396,
"name": "new StorageUnknownError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 397,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 398,
"name": "originalError",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "reference",
"id": 394,
"name": "StorageUnknownError"
},
"overwrites": {
"type": "reference",
"id": 378,
"name": "StorageError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 377,
"name": "StorageError.constructor"
}
},
{
"id": 399,
"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": [
395
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
399
]
}
],
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 32,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 376,
"name": "StorageError"
}
]
},
{
"id": 340,
"name": "Bucket",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 344,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 5,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 341,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 2,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 342,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 3,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 343,
"name": "owner",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 4,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 346,
"name": "public",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 7,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
},
{
"id": 345,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 6,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
344,
341,
342,
343,
346,
345
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 1,
"character": 17
}
]
},
{
"id": 369,
"name": "FetchParameters",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 370,
"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": 68,
"character": 2
}
],
"type": {
"type": "reference",
"qualifiedName": "AbortSignal",
"package": "typescript",
"name": "AbortSignal"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
370
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 64,
"character": 17
}
]
},
{
"id": 347,
"name": "FileObject",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 349,
"name": "bucket_id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 12,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 356,
"name": "buckets",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 19,
"character": 2
}
],
"type": {
"type": "reference",
"id": 340,
"name": "Bucket"
}
},
{
"id": 353,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 16,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 351,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 14,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 354,
"name": "last_accessed_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 17,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 355,
"name": "metadata",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 18,
"character": 2
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "any"
}
],
"qualifiedName": "Record",
"package": "typescript",
"name": "Record"
}
},
{
"id": 348,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 11,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 350,
"name": "owner",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 13,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 352,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 15,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
349,
356,
353,
351,
354,
355,
348,
350,
352
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 10,
"character": 17
}
]
},
{
"id": 360,
"name": "FileOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 361,
"name": "cacheControl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "the `Cache-Control: max-age=<seconds>` seconds value."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 31,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 362,
"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": 35,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 363,
"name": "upsert",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "whether to perform an upsert"
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 39,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
361,
362,
363
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 27,
"character": 17
}
]
},
{
"id": 371,
"name": "Metadata",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 372,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 73,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
372
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 72,
"character": 17
}
]
},
{
"id": 364,
"name": "SearchOptions",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 365,
"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": 46,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 366,
"name": "offset",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The starting position."
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 51,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 368,
"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": 61,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 367,
"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": 56,
"character": 2
}
],
"type": {
"type": "reference",
"id": 357,
"name": "SortBy"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
365,
366,
368,
367
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 42,
"character": 17
}
]
},
{
"id": 357,
"name": "SortBy",
"kind": 256,
"kindString": "Interface",
"flags": {},
"children": [
{
"id": 358,
"name": "column",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 23,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 359,
"name": "order",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 24,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
358,
359
]
}
],
"sources": [
{
"fileName": "src/lib/types.ts",
"line": 22,
"character": 17
}
]
},
{
"id": 373,
"name": "isStorageError",
"kind": 64,
"kindString": "Function",
"flags": {},
"sources": [
{
"fileName": "src/lib/errors.ts",
"line": 10,
"character": 16
}
],
"signatures": [
{
"id": 374,
"name": "isStorageError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 375,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "unknown"
}
}
],
"type": {
"type": "predicate",
"name": "error",
"asserts": false,
"targetType": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
381,
249,
376,
394
]
},
{
"title": "Interfaces",
"kind": 256,
"children": [
340,
369,
347,
360,
371,
364,
357
]
},
{
"title": "Functions",
"kind": 64,
"children": [
373
]
}
],
"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": 79,
"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": 48,
"name": "public",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The visibility of the bucket. By default, buckets are not public."
},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 81,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
48
]
}
]
}
},
"defaultValue": "..."
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 49,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 50,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 84,
"character": 8
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 340,
"name": "Bucket"
},
{
"type": "literal",
"value": "name"
}
],
"qualifiedName": "Pick",
"package": "typescript",
"name": "Pick"
}
},
{
"id": 51,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 85,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
50,
51
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 52,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 53,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 88,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 54,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 89,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
53,
54
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 80,
"name": "deleteBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 185,
"character": 8
}
],
"signatures": [
{
"id": 81,
"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": 82,
"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": 83,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 84,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 189,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 85,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 86,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 189,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
86
]
}
]
}
}
},
{
"id": 87,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 190,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
84,
87
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 88,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 89,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 193,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 90,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 194,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
89,
90
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 69,
"name": "emptyBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 150,
"character": 8
}
],
"signatures": [
{
"id": 70,
"name": "emptyBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Removes all objects inside a single bucket."
},
"parameters": [
{
"id": 71,
"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": 72,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 73,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 154,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 74,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 75,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 154,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
75
]
}
]
}
}
},
{
"id": 76,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 155,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
73,
76
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 77,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 78,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 158,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 79,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 159,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
78,
79
]
}
]
}
}
]
}
],
"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": 340,
"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": 376,
"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": 340,
"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": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
32,
33
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 55,
"name": "updateBucket",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 115,
"character": 8
}
],
"signatures": [
{
"id": 56,
"name": "updateBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates a new Storage bucket"
},
"parameters": [
{
"id": 57,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "A unique identifier for the bucket you are updating."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 58,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 59,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 60,
"name": "public",
"kind": 1024,
"kindString": "Property",
"flags": {},
"comment": {
"shortText": "The visibility of the bucket.\n"
},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 117,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
60
]
}
]
}
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 61,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 62,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 120,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 63,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 64,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 120,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
64
]
}
]
}
}
},
{
"id": 65,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 121,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
62,
65
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 66,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 67,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 124,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 68,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 125,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
67,
68
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
4
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
43,
80,
69,
34,
26,
55
]
}
],
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 7,
"character": 21
}
],
"extendedBy": [
{
"type": "reference",
"id": 249,
"name": "StorageClient"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
3
]
}
],
"sources": [
{
"fileName": "src/packages/StorageBucketApi.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 91,
"name": "packages/StorageFileApi",
"kind": 2,
"kindString": "Module",
"flags": {},
"children": [
{
"id": 92,
"name": "default",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 93,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 27,
"character": 2
}
],
"signatures": [
{
"id": 94,
"name": "new default",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 95,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 96,
"name": "headers",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 97,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": {
"id": 98,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 99,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
},
"defaultValue": "{}"
},
{
"id": 100,
"name": "bucketId",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 101,
"name": "fetch",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 102,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 103,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 104,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
}
},
{
"id": 105,
"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": 92,
"name": "default"
}
}
]
},
{
"id": 169,
"name": "copy",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 226,
"character": 8
}
],
"signatures": [
{
"id": 170,
"name": "copy",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Copies an existing file."
},
"parameters": [
{
"id": 171,
"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": 172,
"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": 173,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 174,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 231,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 175,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 176,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 231,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
176
]
}
]
}
}
},
{
"id": 177,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 232,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
174,
177
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 178,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 179,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 235,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 180,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 236,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
179,
180
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 181,
"name": "createSignedUrl",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 262,
"character": 8
}
],
"signatures": [
{
"id": 182,
"name": "createSignedUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Create signed URL to download file without requiring permissions. This URL can be valid for a set number of seconds."
},
"parameters": [
{
"id": 183,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The file path to be downloaded, including the current file name. For example `folder/image.png`."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 184,
"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.\n"
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 185,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 186,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 267,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 187,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 188,
"name": "signedUrl",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 267,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
188
]
}
]
}
}
},
{
"id": 189,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 268,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
186,
189
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 190,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 191,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 271,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 192,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 272,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
191,
192
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 193,
"name": "createSignedUrls",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 301,
"character": 8
}
],
"signatures": [
{
"id": 194,
"name": "createSignedUrls",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Create signed URLs to download files without requiring permissions. These URLs can be valid for a set number of seconds."
},
"parameters": [
{
"id": 195,
"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": 196,
"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.\n"
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 197,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 198,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 306,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reflection",
"declaration": {
"id": 199,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 200,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 306,
"character": 16
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 201,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 306,
"character": 38
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 202,
"name": "signedUrl",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 306,
"character": 59
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
200,
201,
202
]
}
]
}
}
}
},
{
"id": 203,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 307,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
198,
203
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 204,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 205,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 310,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 206,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 311,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
205,
206
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 207,
"name": "download",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 342,
"character": 8
}
],
"signatures": [
{
"id": 208,
"name": "download",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Downloads a file."
},
"parameters": [
{
"id": 209,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The file path to be downloaded, including the path and file name. For example `folder/image.png`.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 210,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 211,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 346,
"character": 8
}
],
"type": {
"type": "reference",
"qualifiedName": "Blob",
"package": "typescript",
"name": "Blob"
}
},
{
"id": 212,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 347,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
211,
212
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 213,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 214,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 350,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 215,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 351,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
214,
215
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 216,
"name": "getPublicUrl",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 376,
"character": 2
}
],
"signatures": [
{
"id": 217,
"name": "getPublicUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Retrieve URLs for assets in public buckets and encapsulates it in a return object"
},
"parameters": [
{
"id": 218,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The file path to be downloaded, including the path and file name. For example `folder/image.png`.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 219,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 220,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 376,
"character": 32
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 221,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 222,
"name": "publicUrl",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 376,
"character": 40
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
222
]
}
]
}
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
220
]
}
]
}
}
}
]
},
{
"id": 232,
"name": "list",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 482,
"character": 8
}
],
"signatures": [
{
"id": 233,
"name": "list",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Lists all the files within a bucket."
},
"parameters": [
{
"id": 234,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The folder path.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 235,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 364,
"name": "SearchOptions"
}
},
{
"id": 236,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 369,
"name": "FetchParameters"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 237,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 238,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 488,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 347,
"name": "FileObject"
}
}
},
{
"id": 239,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 489,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
238,
239
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 240,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 241,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 492,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 242,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 493,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
241,
242
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 157,
"name": "move",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 190,
"character": 8
}
],
"signatures": [
{
"id": 158,
"name": "move",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Moves an existing file."
},
"parameters": [
{
"id": 159,
"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": 160,
"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": 161,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 162,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 195,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 163,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 164,
"name": "message",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 195,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
164
]
}
]
}
}
},
{
"id": 165,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 196,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
162,
165
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 166,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 167,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 199,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 168,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 200,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
167,
168
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 223,
"name": "remove",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 386,
"character": 8
}
],
"signatures": [
{
"id": 224,
"name": "remove",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Deletes files within the same bucket"
},
"parameters": [
{
"id": 225,
"name": "paths",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "An array of files to be deleted, 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": 226,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 227,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 390,
"character": 8
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"id": 347,
"name": "FileObject"
}
}
},
{
"id": 228,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 391,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
227,
228
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 229,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 230,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 394,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 231,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 395,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
230,
231
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 144,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 157,
"character": 8
}
],
"signatures": [
{
"id": 145,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Replaces an existing file at the specified path with a new one."
},
"parameters": [
{
"id": 146,
"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 upload."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 147,
"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": 148,
"name": "fileOptions",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 360,
"name": "FileOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 149,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 150,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 173,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 151,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 152,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 173,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
152
]
}
]
}
}
},
{
"id": 153,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 174,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
150,
153
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 154,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 155,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 177,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 156,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 178,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
155,
156
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 131,
"name": "upload",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 124,
"character": 8
}
],
"signatures": [
{
"id": 132,
"name": "upload",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Uploads a file to an existing bucket."
},
"parameters": [
{
"id": 133,
"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 upload."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 134,
"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": 135,
"name": "fileOptions",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 360,
"name": "FileOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 136,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 137,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 140,
"character": 8
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 138,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 139,
"name": "path",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 140,
"character": 16
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
139
]
}
]
}
}
},
{
"id": 140,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 141,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
137,
140
]
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 141,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 142,
"name": "data",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 144,
"character": 8
}
],
"type": {
"type": "literal",
"value": null
}
},
{
"id": 143,
"name": "error",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 145,
"character": 8
}
],
"type": {
"type": "reference",
"id": 376,
"name": "StorageError"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
142,
143
]
}
]
}
}
]
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
93
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
169,
181,
193,
207,
216,
232,
157,
223,
144,
131
]
}
],
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 21,
"character": 21
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
92
]
}
],
"sources": [
{
"fileName": "src/packages/StorageFileApi.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 2,
"children": [
1,
2,
91
]
}
]
}
Reference in New Issue View Git Blame Copy Permalink