dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-14 13:49:09 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
ee71c21bf2fb0efca696a2c94adc77de4e60f52a
supabase/web/spec/storage.json
T
phamhieu 365f60a1ca fix: update document specs
2021-05-18 11:49:58 +07:00

6158 lines
137 KiB
JSON
Raw Blame History

{
"id": 0,
"name": "@supabase/storage-js",
"kind": 0,
"flags": {},
"originalName": "",
"children": [
{
"id": 231,
"name": "\"SupabaseStorageClient\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/SupabaseStorageClient.ts",
"children": [
{
"id": 232,
"name": "SupabaseStorageClient",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 233,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 234,
"name": "new SupabaseStorageClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 235,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 236,
"name": "headers",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 237,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 238,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 239,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "SupabaseStorageClient.ts",
"line": 4,
"character": 35
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 232,
"name": "SupabaseStorageClient"
},
"overwrites": {
"type": "reference",
"id": 93,
"name": "StorageBucketApi.__constructor"
}
}
],
"sources": [
{
"fileName": "SupabaseStorageClient.ts",
"line": 3,
"character": 61
}
],
"overwrites": {
"type": "reference",
"id": 93,
"name": "StorageBucketApi.__constructor"
}
},
{
"id": 244,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 6,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 245,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 246,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 247,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 6,
"character": 20
}
]
}
},
"inheritedFrom": {
"type": "reference",
"id": 89,
"name": "StorageBucketApi.headers"
}
},
{
"id": 243,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 5,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"inheritedFrom": {
"type": "reference",
"id": 88,
"name": "StorageBucketApi.url"
}
},
{
"id": 259,
"name": "createBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 260,
"name": "createBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new Storage bucket",
"returns": "newly created bucket id\n"
},
"parameters": [
{
"id": 261,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A unique identifier for the bucket you are creating."
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 262,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 263,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 48
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 264,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 70
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
263,
264
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 42
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 111,
"name": "StorageBucketApi.createBucket"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 20
}
],
"inheritedFrom": {
"type": "reference",
"id": 111,
"name": "StorageBucketApi.createBucket"
}
},
{
"id": 273,
"name": "deleteBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 274,
"name": "deleteBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": 275,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to delete.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 276,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 277,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 278,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 279,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
279
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 280,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 54
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
277,
280
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 13
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 125,
"name": "StorageBucketApi.deleteBucket"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 76,
"character": 20
}
],
"inheritedFrom": {
"type": "reference",
"id": 125,
"name": "StorageBucketApi.deleteBucket"
}
},
{
"id": 265,
"name": "emptyBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 266,
"name": "emptyBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Removes all objects inside a single bucket."
},
"parameters": [
{
"id": 267,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to empty.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 268,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 269,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 270,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 271,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
271
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 272,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 54
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
269,
272
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 13
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 117,
"name": "StorageBucketApi.emptyBucket"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 59,
"character": 19
}
],
"inheritedFrom": {
"type": "reference",
"id": 117,
"name": "StorageBucketApi.emptyBucket"
}
},
{
"id": 240,
"name": "from",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 241,
"name": "from",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Perform file operation in a bucket."
},
"parameters": [
{
"id": 242,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The bucket id to operate on.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"id": 137,
"name": "StorageFileApi"
}
}
],
"sources": [
{
"fileName": "SupabaseStorageClient.ts",
"line": 13,
"character": 6
}
]
},
{
"id": 253,
"name": "getBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 254,
"name": "getBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves the details of an existing Storage bucket."
},
"parameters": [
{
"id": 255,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to retrieve.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 256,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 257,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 45
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "Bucket"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 258,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 67
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
257,
258
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 39
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 105,
"name": "StorageBucketApi.getBucket"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 17
}
],
"inheritedFrom": {
"type": "reference",
"id": 105,
"name": "StorageBucketApi.getBucket"
}
},
{
"id": 248,
"name": "listBuckets",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 249,
"name": "listBuckets",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves the details of all Storage buckets within an existing product."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 250,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 251,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "array",
"elementType": {
"type": "reference",
"id": 58,
"name": "Bucket"
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 252,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 61
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
251,
252
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 31
}
]
}
}
],
"name": "Promise"
},
"inheritedFrom": {
"type": "reference",
"id": 100,
"name": "StorageBucketApi.listBuckets"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 19
}
],
"inheritedFrom": {
"type": "reference",
"id": 100,
"name": "StorageBucketApi.listBuckets"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
233
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
244,
243
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
259,
273,
265,
240,
253,
248
]
}
],
"sources": [
{
"fileName": "SupabaseStorageClient.ts",
"line": 3,
"character": 34
}
],
"extendedTypes": [
{
"type": "reference",
"id": 87,
"name": "StorageBucketApi"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
232
]
}
],
"sources": [
{
"fileName": "SupabaseStorageClient.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 281,
"name": "\"index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/index.ts",
"children": [
{
"id": 282,
"name": "Bucket",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 58
},
{
"id": 283,
"name": "FileObject",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 64
},
{
"id": 285,
"name": "FileOptions",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 78
},
{
"id": 287,
"name": "Metadata",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 84
},
{
"id": 286,
"name": "SearchOptions",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 80
},
{
"id": 284,
"name": "SortBy",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 75
}
],
"groups": [
{
"title": "References",
"kind": 16777216,
"children": [
282,
283,
285,
287,
286,
284
]
}
],
"sources": [
{
"fileName": "index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 86,
"name": "\"lib/StorageBucketApi\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/StorageBucketApi.ts",
"children": [
{
"id": 87,
"name": "StorageBucketApi",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 93,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 94,
"name": "new StorageBucketApi",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 95,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 96,
"name": "headers",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 97,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 98,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 99,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 8,
"character": 35
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 87,
"name": "StorageBucketApi"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 6,
"character": 46
}
]
},
{
"id": 89,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 6,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 90,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 91,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 92,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 6,
"character": 20
}
]
}
}
},
{
"id": 88,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 5,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 111,
"name": "createBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 112,
"name": "createBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Creates a new Storage bucket",
"returns": "newly created bucket id\n"
},
"parameters": [
{
"id": 113,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "A unique identifier for the bucket you are creating."
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 114,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 115,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 48
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 116,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 70
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
115,
116
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 42
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 45,
"character": 20
}
]
},
{
"id": 125,
"name": "deleteBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 126,
"name": "deleteBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": 127,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to delete.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 128,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 129,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 130,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 131,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
131
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 132,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 54
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
129,
132
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 78,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 76,
"character": 20
}
]
},
{
"id": 117,
"name": "emptyBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 118,
"name": "emptyBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Removes all objects inside a single bucket."
},
"parameters": [
{
"id": 119,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to empty.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 120,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 121,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 122,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 123,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
123
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 124,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 54
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
121,
124
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 61,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 59,
"character": 19
}
]
},
{
"id": 105,
"name": "getBucket",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 106,
"name": "getBucket",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves the details of an existing Storage bucket."
},
"parameters": [
{
"id": 107,
"name": "id",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The unique identifier of the bucket you would like to retrieve.\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 108,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 109,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 45
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"id": 58,
"name": "Bucket"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 110,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 67
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
109,
110
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 39
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 30,
"character": 17
}
]
},
{
"id": 100,
"name": "listBuckets",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 101,
"name": "listBuckets",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Retrieves the details of all Storage buckets within an existing product."
},
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 102,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 103,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 37
}
],
"type": {
"type": "union",
"types": [
{
"type": "array",
"elementType": {
"type": "reference",
"id": 58,
"name": "Bucket"
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 104,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 61
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
103,
104
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 31
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 16,
"character": 19
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
93
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
89,
88
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
111,
125,
117,
105,
100
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 4,
"character": 29
}
],
"extendedBy": [
{
"type": "reference",
"id": 232,
"name": "SupabaseStorageClient"
}
]
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
87
]
}
],
"sources": [
{
"fileName": "lib/StorageBucketApi.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 136,
"name": "\"lib/StorageFileApi\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/StorageFileApi.ts",
"children": [
{
"id": 137,
"name": "StorageFileApi",
"kind": 128,
"kindString": "Class",
"flags": {
"isExported": true
},
"children": [
{
"id": 144,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 145,
"name": "new StorageFileApi",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 146,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 147,
"name": "headers",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "reflection",
"declaration": {
"id": 148,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 149,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 150,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 23,
"character": 35
}
]
}
},
"defaultValue": "{}"
},
{
"id": 151,
"name": "bucketId",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"type": {
"type": "reference",
"id": 137,
"name": "StorageFileApi"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 21,
"character": 29
}
]
},
{
"id": 143,
"name": "bucketId",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 21,
"character": 20
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 139,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 20,
"character": 19
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 140,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 141,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 142,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 20,
"character": 20
}
]
}
}
},
{
"id": 138,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true,
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 19,
"character": 15
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 211,
"name": "_getFinalPath",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 212,
"name": "_getFinalPath",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 213,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 254,
"character": 15
}
]
},
{
"id": 181,
"name": "createSignedUrl",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 182,
"name": "createSignedUrl",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"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": {
"isExported": true
},
"comment": {
"text": "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": {
"isExported": true
},
"comment": {
"text": "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": "reflection",
"declaration": {
"id": 185,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 186,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 143,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 187,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 188,
"name": "signedURL",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 143,
"character": 21
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
188
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 143,
"character": 9
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 189,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 144,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 190,
"name": "signedURL",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 145,
"character": 13
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
186,
189,
190
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 142,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 139,
"character": 23
}
]
},
{
"id": 191,
"name": "download",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 192,
"name": "download",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Downloads a file."
},
"parameters": [
{
"id": 193,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "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": "reflection",
"declaration": {
"id": 194,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 195,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 167,
"character": 46
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Blob"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 196,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 167,
"character": 66
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
195,
196
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 167,
"character": 40
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 167,
"character": 16
}
]
},
{
"id": 203,
"name": "list",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 204,
"name": "list",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Lists all the files within a bucket."
},
"parameters": [
{
"id": 205,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "The folder path."
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 206,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Search options, including `limit`, `offset`, and `sortBy`."
},
"type": {
"type": "reference",
"id": 80,
"name": "SearchOptions"
}
},
{
"id": 207,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "Fetch parameters, currently only supports `signal`, which is an AbortController's signal\n"
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 208,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 209,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 239,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "array",
"elementType": {
"type": "reference",
"id": 64,
"name": "FileObject"
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 210,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 239,
"character": 47
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
209,
210
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 239,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 235,
"character": 12
}
]
},
{
"id": 172,
"name": "move",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 173,
"name": "move",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Moves an existing file, optionally renaming it at the same time."
},
"parameters": [
{
"id": 174,
"name": "fromPath",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The original file path, including the current file name. For example `folder/image.png`."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 175,
"name": "toPath",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "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": "reflection",
"declaration": {
"id": 176,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 177,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 120,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 178,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 179,
"name": "message",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 120,
"character": 30
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
179
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 120,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 180,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 120,
"character": 54
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
177,
180
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 120,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 117,
"character": 12
}
]
},
{
"id": 197,
"name": "remove",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 198,
"name": "remove",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Deletes files within the same bucket"
},
"parameters": [
{
"id": 199,
"name": "paths",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "An array of files to be deletes, 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": "reflection",
"declaration": {
"id": 200,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 201,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 186,
"character": 47
}
],
"type": {
"type": "union",
"types": [
{
"type": "array",
"elementType": {
"type": "reference",
"id": 64,
"name": "FileObject"
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 202,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 186,
"character": 75
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
201,
202
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 186,
"character": 41
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 186,
"character": 14
}
]
},
{
"id": 162,
"name": "update",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 163,
"name": "update",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Replaces an existing file at the specified path with a new one."
},
"parameters": [
{
"id": 164,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The relative file path including the bucket ID. Should be of the format `bucket/folder/subfolder`. The bucket already exist before attempting to upload."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 165,
"name": "file",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The file object to be stored in the bucket."
},
"type": {
"type": "reference",
"name": "File"
}
},
{
"id": 166,
"name": "fileOptions",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "HTTP headers. For example `cacheControl`\n"
},
"type": {
"type": "reference",
"id": 78,
"name": "FileOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 167,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 168,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 81,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 169,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 170,
"name": "Key",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 81,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
170
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 81,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 171,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 81,
"character": 50
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
168,
171
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 81,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 77,
"character": 14
}
]
},
{
"id": 152,
"name": "upload",
"kind": 2048,
"kindString": "Method",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 153,
"name": "upload",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"comment": {
"shortText": "Uploads a file to an existing bucket."
},
"parameters": [
{
"id": 154,
"name": "path",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The relative file path including the bucket ID. Should be of the format `bucket/folder/subfolder/filename.png`. The bucket must already exist before attempting to upload."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 155,
"name": "file",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"comment": {
"text": "The File object to be stored in the bucket."
},
"type": {
"type": "reference",
"name": "File"
}
},
{
"id": 156,
"name": "fileOptions",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"text": "HTTP headers. For example `cacheControl`\n"
},
"type": {
"type": "reference",
"id": 78,
"name": "FileOptions"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reflection",
"declaration": {
"id": 157,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 158,
"name": "data",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 40,
"character": 19
}
],
"type": {
"type": "union",
"types": [
{
"type": "reflection",
"declaration": {
"id": 159,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"children": [
{
"id": 160,
"name": "Key",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 40,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
160
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 40,
"character": 20
}
]
}
},
{
"type": "intrinsic",
"name": "null"
}
]
}
},
{
"id": 161,
"name": "error",
"kind": 32,
"kindString": "Variable",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 40,
"character": 50
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"name": "Error"
},
{
"type": "intrinsic",
"name": "null"
}
]
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
158,
161
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 40,
"character": 13
}
]
}
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 36,
"character": 14
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
144
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
143,
139,
138
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
211,
181,
191,
203,
172,
197,
162,
152
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 18,
"character": 27
}
]
},
{
"id": 220,
"name": "DEFAULT_FILE_OPTIONS",
"kind": 2097152,
"kindString": "Object literal",
"flags": {
"isConst": true
},
"children": [
{
"id": 221,
"name": "cacheControl",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 15,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"3600\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
221
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 14,
"character": 26
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 214,
"name": "DEFAULT_SEARCH_OPTIONS",
"kind": 2097152,
"kindString": "Object literal",
"flags": {
"isConst": true
},
"children": [
{
"id": 215,
"name": "limit",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 6,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "100"
},
{
"id": 216,
"name": "offset",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 7,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "0"
},
{
"id": 217,
"name": "sortBy",
"kind": 2097152,
"kindString": "Object literal",
"flags": {},
"children": [
{
"id": 218,
"name": "column",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 9,
"character": 10
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"name\""
},
{
"id": 219,
"name": "order",
"kind": 32,
"kindString": "Variable",
"flags": {},
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 10,
"character": 9
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "\"asc\""
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
218,
219
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 8,
"character": 8
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Variables",
"kind": 32,
"children": [
215,
216
]
},
{
"title": "Object literals",
"kind": 2097152,
"children": [
217
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 5,
"character": 28
}
],
"type": {
"type": "intrinsic",
"name": "object"
}
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
137
]
},
{
"title": "Object literals",
"kind": 2097152,
"children": [
220,
214
]
}
],
"sources": [
{
"fileName": "lib/StorageFileApi.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 1,
"name": "\"lib/fetch\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/fetch.ts",
"children": [
{
"id": 2,
"name": "FetchOptions",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 3,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 4,
"character": 9
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "reflection",
"declaration": {
"id": 4,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"indexSignature": [
{
"id": 5,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 6,
"name": "key",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
]
}
}
]
}
},
{
"id": 7,
"name": "noResolveJson",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 7,
"character": 15
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "false"
},
{
"type": "intrinsic",
"name": "true"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
3,
7
]
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 3,
"character": 29
}
]
},
{
"id": 8,
"name": "FetchParameters",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 9,
"name": "signal",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 11,
"character": 8
}
],
"type": {
"type": "reference",
"name": "AbortSignal"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
9
]
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 10,
"character": 32
}
]
},
{
"id": 10,
"name": "RequestMethodType",
"kind": 4194304,
"kindString": "Type alias",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 14,
"character": 29
}
],
"type": {
"type": "union",
"types": [
{
"type": "stringLiteral",
"value": "GET"
},
{
"type": "stringLiteral",
"value": "POST"
},
{
"type": "stringLiteral",
"value": "PUT"
},
{
"type": "stringLiteral",
"value": "DELETE"
}
]
}
},
{
"id": 11,
"name": "_getErrorMessage",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 12,
"name": "_getErrorMessage",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 13,
"name": "err",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 16,
"character": 22
}
]
},
{
"id": 18,
"name": "_getRequestParams",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 19,
"name": "_getRequestParams",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 20,
"name": "method",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 10,
"name": "RequestMethodType"
}
},
{
"id": 21,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 22,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
},
{
"id": 23,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 24,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"indexSignature": [
{
"id": 25,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 26,
"name": "k",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
]
}
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 31,
"character": 23
}
]
},
{
"id": 27,
"name": "_handleRequest",
"kind": 64,
"kindString": "Function",
"flags": {},
"signatures": [
{
"id": 28,
"name": "_handleRequest",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 29,
"name": "method",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reference",
"id": 10,
"name": "RequestMethodType"
}
},
{
"id": 30,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 31,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 32,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
},
{
"id": 33,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "object"
}
]
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 48,
"character": 29
}
]
},
{
"id": 34,
"name": "get",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 35,
"name": "get",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 36,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 37,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 38,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 67,
"character": 25
}
]
},
{
"id": 14,
"name": "handleError",
"kind": 64,
"kindString": "Function",
"flags": {
"isConst": true
},
"signatures": [
{
"id": 15,
"name": "handleError",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 16,
"name": "error",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 17,
"name": "reject",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 19,
"character": 17
}
]
},
{
"id": 39,
"name": "post",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 40,
"name": "post",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 41,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 42,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 43,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 44,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 75,
"character": 26
}
]
},
{
"id": 45,
"name": "put",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 46,
"name": "put",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 47,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 48,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 49,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 50,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 84,
"character": 25
}
]
},
{
"id": 51,
"name": "remove",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true
},
"signatures": [
{
"id": 52,
"name": "remove",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"parameters": [
{
"id": 53,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 54,
"name": "body",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "object"
}
},
{
"id": 55,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 2,
"name": "FetchOptions"
}
},
{
"id": 56,
"name": "parameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isExported": true,
"isOptional": true
},
"type": {
"type": "reference",
"id": 8,
"name": "FetchParameters"
}
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "Promise"
}
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 93,
"character": 28
}
]
}
],
"groups": [
{
"title": "Interfaces",
"kind": 256,
"children": [
2,
8
]
},
{
"title": "Type aliases",
"kind": 4194304,
"children": [
10
]
},
{
"title": "Functions",
"kind": 64,
"children": [
11,
18,
27,
34,
14,
39,
45,
51
]
}
],
"sources": [
{
"fileName": "lib/fetch.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 133,
"name": "\"lib/helpers\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/helpers.ts",
"children": [
{
"id": 134,
"name": "isBrowser",
"kind": 64,
"kindString": "Function",
"flags": {
"isExported": true,
"isConst": true
},
"signatures": [
{
"id": 135,
"name": "isBrowser",
"kind": 4096,
"kindString": "Call signature",
"flags": {
"isExported": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 1,
"character": 22
}
]
}
],
"groups": [
{
"title": "Functions",
"kind": 64,
"children": [
134
]
}
],
"sources": [
{
"fileName": "lib/helpers.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 222,
"name": "\"lib/index\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/index.ts",
"children": [
{
"id": 225,
"name": "Bucket",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 58
},
{
"id": 226,
"name": "FileObject",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 64
},
{
"id": 228,
"name": "FileOptions",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 78
},
{
"id": 230,
"name": "Metadata",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 84
},
{
"id": 229,
"name": "SearchOptions",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 80
},
{
"id": 227,
"name": "SortBy",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 75
},
{
"id": 223,
"name": "StorageBucketApi",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 87
},
{
"id": 224,
"name": "StorageFileApi",
"kind": 16777216,
"kindString": "Reference",
"flags": {
"isExported": true
},
"target": 137
}
],
"groups": [
{
"title": "References",
"kind": 16777216,
"children": [
225,
226,
228,
230,
229,
227,
223,
224
]
}
],
"sources": [
{
"fileName": "lib/index.ts",
"line": 1,
"character": 0
}
]
},
{
"id": 57,
"name": "\"lib/types\"",
"kind": 1,
"kindString": "Module",
"flags": {
"isExported": true
},
"originalName": "/home/runner/work/storage-js/storage-js/src/lib/types.ts",
"children": [
{
"id": 58,
"name": "Bucket",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 62,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 5,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 59,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 2,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 60,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 3,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 61,
"name": "owner",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 4,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 63,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 6,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
62,
59,
60,
61,
63
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 1,
"character": 23
}
]
},
{
"id": 64,
"name": "FileObject",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 66,
"name": "bucket_id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 11,
"character": 11
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 74,
"name": "buckets",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 18,
"character": 9
}
],
"type": {
"type": "reference",
"id": 58,
"name": "Bucket"
}
},
{
"id": 70,
"name": "created_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 15,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 68,
"name": "id",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 13,
"character": 4
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 71,
"name": "last_accessed_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 16,
"character": 18
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 72,
"name": "metadata",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 17,
"character": 10
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 73,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 17,
"character": 11
}
]
}
}
},
{
"id": 65,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 10,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 67,
"name": "owner",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 12,
"character": 7
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 69,
"name": "updated_at",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 14,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
66,
74,
70,
68,
71,
72,
65,
67,
69
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 9,
"character": 27
}
]
},
{
"id": 78,
"name": "FileOptions",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 79,
"name": "cacheControl",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 27,
"character": 14
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
79
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 26,
"character": 28
}
]
},
{
"id": 84,
"name": "Metadata",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 85,
"name": "name",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 43,
"character": 6
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
85
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 42,
"character": 25
}
]
},
{
"id": 80,
"name": "SearchOptions",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 81,
"name": "limit",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "The number of files you want to be returned."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 32,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 82,
"name": "offset",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "The starting position."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 35,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "number"
}
]
}
},
{
"id": 83,
"name": "sortBy",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"comment": {
"shortText": "The column to sort by. Can be any column inside a FileObject."
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 38,
"character": 8
}
],
"type": {
"type": "reference",
"id": 75,
"name": "SortBy"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
81,
82,
83
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 30,
"character": 30
}
]
},
{
"id": 75,
"name": "SortBy",
"kind": 256,
"kindString": "Interface",
"flags": {
"isExported": true
},
"children": [
{
"id": 76,
"name": "column",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 22,
"character": 8
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 77,
"name": "order",
"kind": 1024,
"kindString": "Property",
"flags": {
"isExported": true,
"isOptional": true
},
"sources": [
{
"fileName": "lib/types.ts",
"line": 23,
"character": 7
}
],
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "undefined"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
76,
77
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 21,
"character": 23
}
]
}
],
"groups": [
{
"title": "Interfaces",
"kind": 256,
"children": [
58,
64,
78,
84,
80,
75
]
}
],
"sources": [
{
"fileName": "lib/types.ts",
"line": 1,
"character": 0
}
]
}
],
"groups": [
{
"title": "Modules",
"kind": 1,
"children": [
231,
281,
86,
136,
1,
133,
222,
57
]
}
]
}
Reference in new issue View Git Blame Copy Permalink