Files
supabase/apps/docs/spec/enrichments/tsdoc_v2/functions_dereferenced.json
2024-01-03 18:54:23 +01:00

1528 lines
45 KiB
JSON

{
"id": 0,
"name": "@supabase/functions-js",
"kind": 1,
"kindString": "Project",
"flags": {},
"originalName": "",
"children": [
{
"id": 1,
"name": "FunctionsClient",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 2,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/FunctionsClient.ts",
"line": 16,
"character": 2
}
],
"signatures": [
{
"id": 3,
"name": "new FunctionsClient",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 4,
"name": "url",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 5,
"name": "__namedParameters",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "reflection",
"declaration": {
"id": 6,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 8,
"name": "customFetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/FunctionsClient.ts",
"line": 23,
"character": 6
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 9,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 10,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 11,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
},
{
"type": "reference",
"qualifiedName": "URL",
"package": "typescript",
"name": "URL"
}
]
}
},
{
"id": 12,
"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"
}
}
]
}
}
},
{
"id": 7,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"sources": [
{
"fileName": "src/FunctionsClient.ts",
"line": 22,
"character": 6
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "string"
}
],
"qualifiedName": "Record",
"package": "typescript",
"name": "Record"
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
8,
7
]
}
]
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"id": 1,
"name": "FunctionsClient"
}
}
]
},
{
"id": 15,
"name": "fetch",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/FunctionsClient.ts",
"line": 14,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 16,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"signatures": [
{
"id": 17,
"name": "__type",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"parameters": [
{
"id": 18,
"name": "input",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"qualifiedName": "RequestInfo",
"package": "typescript",
"name": "RequestInfo"
},
{
"type": "reference",
"qualifiedName": "URL",
"package": "typescript",
"name": "URL"
}
]
}
},
{
"id": 19,
"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"
}
}
]
}
}
},
{
"id": 14,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/FunctionsClient.ts",
"line": 13,
"character": 12
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "string"
}
],
"qualifiedName": "Record",
"package": "typescript",
"name": "Record"
}
},
{
"id": 13,
"name": "url",
"kind": 1024,
"kindString": "Property",
"flags": {
"isProtected": true
},
"sources": [
{
"fileName": "src/FunctionsClient.ts",
"line": 12,
"character": 12
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 23,
"name": "invoke",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/FunctionsClient.ts",
"line": 44,
"character": 8
}
],
"signatures": [
{
"id": 24,
"name": "invoke",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Invokes a function"
},
"typeParameter": [
{
"id": 25,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {},
"default": {
"type": "intrinsic",
"name": "any"
}
}
],
"parameters": [
{
"id": 26,
"name": "functionName",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "The name of the Function to invoke."
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 27,
"name": "options",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "Options for invoking the Function.\n"
},
"type": {
"type": "reference",
"id": 28,
"name": "FunctionInvokeOptions",
"dereferenced": {
"id": 28,
"name": "FunctionInvokeOptions",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 44,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 29,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 35,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The body of the request."
},
"sources": [
{
"fileName": "src/types.ts",
"line": 56,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"qualifiedName": "File",
"package": "typescript",
"name": "File"
},
{
"type": "reference",
"qualifiedName": "Blob",
"package": "typescript",
"name": "Blob"
},
{
"type": "reference",
"qualifiedName": "ArrayBuffer",
"package": "typescript",
"name": "ArrayBuffer"
},
{
"type": "reference",
"qualifiedName": "FormData",
"package": "typescript",
"name": "FormData"
},
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Uint8Array",
"package": "typescript",
"name": "Uint8Array"
}
],
"qualifiedName": "ReadableStream",
"package": "typescript",
"name": "ReadableStream"
},
{
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "any"
}
],
"qualifiedName": "Record",
"package": "typescript",
"name": "Record"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 30,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Object representing the headers to send with the request."
},
"sources": [
{
"fileName": "src/types.ts",
"line": 48,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 31,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 48,
"character": 12
}
],
"indexSignature": {
"id": 32,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 33,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 34,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The HTTP verb of the request"
},
"sources": [
{
"fileName": "src/types.ts",
"line": 52,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "POST"
},
{
"type": "literal",
"value": "GET"
},
{
"type": "literal",
"value": "PUT"
},
{
"type": "literal",
"value": "PATCH"
},
{
"type": "literal",
"value": "DELETE"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
35,
30,
34
]
}
],
"sources": [
{
"fileName": "src/types.ts",
"line": 44,
"character": 36
}
]
}
}
}
},
"defaultValue": "{}"
}
],
"type": {
"type": "reference",
"typeArguments": [
{
"type": "reference",
"id": 58,
"typeArguments": [
{
"type": "reference",
"id": 25,
"name": "T"
}
],
"name": "FunctionsResponse"
}
],
"qualifiedName": "Promise",
"package": "typescript",
"name": "Promise"
}
}
]
},
{
"id": 20,
"name": "setAuth",
"kind": 2048,
"kindString": "Method",
"flags": {},
"sources": [
{
"fileName": "src/FunctionsClient.ts",
"line": 35,
"character": 2
}
],
"signatures": [
{
"id": 21,
"name": "setAuth",
"kind": 4096,
"kindString": "Call signature",
"flags": {},
"comment": {
"shortText": "Updates the authorization header"
},
"parameters": [
{
"id": 22,
"name": "token",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"comment": {
"shortText": "the new jwt token sent in the authorisation header\n"
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
2
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
15,
14,
13
]
},
{
"title": "Methods",
"kind": 2048,
"children": [
23,
20
]
}
],
"sources": [
{
"fileName": "src/FunctionsClient.ts",
"line": 11,
"character": 13
}
]
},
{
"id": 36,
"name": "FunctionsError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 37,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 19,
"character": 2
}
],
"signatures": [
{
"id": 38,
"name": "new FunctionsError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 39,
"name": "message",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 40,
"name": "name",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "'FunctionsError'"
},
{
"id": 41,
"name": "context",
"kind": 32768,
"kindString": "Parameter",
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"id": 36,
"name": "FunctionsError"
},
"overwrites": {
"type": "reference",
"name": "Error.constructor"
}
}
],
"overwrites": {
"type": "reference",
"name": "Error.constructor"
}
},
{
"id": 42,
"name": "context",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 18,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
37
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
42
]
}
],
"sources": [
{
"fileName": "src/types.ts",
"line": 17,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"qualifiedName": "Error",
"package": "typescript",
"name": "Error"
}
],
"extendedBy": [
{
"type": "reference",
"id": 43,
"name": "FunctionsFetchError"
},
{
"type": "reference",
"id": 48,
"name": "FunctionsHttpError"
},
{
"type": "reference",
"id": 53,
"name": "FunctionsRelayError"
}
]
},
{
"id": 43,
"name": "FunctionsFetchError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 44,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 27,
"character": 2
}
],
"signatures": [
{
"id": 45,
"name": "new FunctionsFetchError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 46,
"name": "context",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"id": 43,
"name": "FunctionsFetchError"
},
"overwrites": {
"type": "reference",
"id": 38,
"name": "FunctionsError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 37,
"name": "FunctionsError.constructor"
}
},
{
"id": 47,
"name": "context",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 18,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "any"
},
"inheritedFrom": {
"type": "reference",
"id": 42,
"name": "FunctionsError.context"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
44
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
47
]
}
],
"sources": [
{
"fileName": "src/types.ts",
"line": 26,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 36,
"name": "FunctionsError"
}
]
},
{
"id": 48,
"name": "FunctionsHttpError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 49,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 39,
"character": 2
}
],
"signatures": [
{
"id": 50,
"name": "new FunctionsHttpError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 51,
"name": "context",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"id": 48,
"name": "FunctionsHttpError"
},
"overwrites": {
"type": "reference",
"id": 38,
"name": "FunctionsError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 37,
"name": "FunctionsError.constructor"
}
},
{
"id": 52,
"name": "context",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 18,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "any"
},
"inheritedFrom": {
"type": "reference",
"id": 42,
"name": "FunctionsError.context"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
49
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
52
]
}
],
"sources": [
{
"fileName": "src/types.ts",
"line": 38,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 36,
"name": "FunctionsError"
}
]
},
{
"id": 53,
"name": "FunctionsRelayError",
"kind": 128,
"kindString": "Class",
"flags": {},
"children": [
{
"id": 54,
"name": "constructor",
"kind": 512,
"kindString": "Constructor",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 33,
"character": 2
}
],
"signatures": [
{
"id": 55,
"name": "new FunctionsRelayError",
"kind": 16384,
"kindString": "Constructor signature",
"flags": {},
"parameters": [
{
"id": 56,
"name": "context",
"kind": 32768,
"kindString": "Parameter",
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "reference",
"id": 53,
"name": "FunctionsRelayError"
},
"overwrites": {
"type": "reference",
"id": 38,
"name": "FunctionsError.constructor"
}
}
],
"overwrites": {
"type": "reference",
"id": 37,
"name": "FunctionsError.constructor"
}
},
{
"id": 57,
"name": "context",
"kind": 1024,
"kindString": "Property",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 18,
"character": 2
}
],
"type": {
"type": "intrinsic",
"name": "any"
},
"inheritedFrom": {
"type": "reference",
"id": 42,
"name": "FunctionsError.context"
}
}
],
"groups": [
{
"title": "Constructors",
"kind": 512,
"children": [
54
]
},
{
"title": "Properties",
"kind": 1024,
"children": [
57
]
}
],
"sources": [
{
"fileName": "src/types.ts",
"line": 32,
"character": 13
}
],
"extendedTypes": [
{
"type": "reference",
"id": 36,
"name": "FunctionsError"
}
]
},
{
"id": 28,
"name": "FunctionInvokeOptions",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 44,
"character": 12
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 29,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"children": [
{
"id": 35,
"name": "body",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The body of the request."
},
"sources": [
{
"fileName": "src/types.ts",
"line": 56,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "reference",
"qualifiedName": "File",
"package": "typescript",
"name": "File"
},
{
"type": "reference",
"qualifiedName": "Blob",
"package": "typescript",
"name": "Blob"
},
{
"type": "reference",
"qualifiedName": "ArrayBuffer",
"package": "typescript",
"name": "ArrayBuffer"
},
{
"type": "reference",
"qualifiedName": "FormData",
"package": "typescript",
"name": "FormData"
},
{
"type": "reference",
"typeArguments": [
{
"type": "reference",
"qualifiedName": "Uint8Array",
"package": "typescript",
"name": "Uint8Array"
}
],
"qualifiedName": "ReadableStream",
"package": "typescript",
"name": "ReadableStream"
},
{
"type": "reference",
"typeArguments": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "any"
}
],
"qualifiedName": "Record",
"package": "typescript",
"name": "Record"
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 30,
"name": "headers",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "Object representing the headers to send with the request."
},
"sources": [
{
"fileName": "src/types.ts",
"line": 48,
"character": 2
}
],
"type": {
"type": "reflection",
"declaration": {
"id": 31,
"name": "__type",
"kind": 65536,
"kindString": "Type literal",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 48,
"character": 12
}
],
"indexSignature": {
"id": 32,
"name": "__index",
"kind": 8192,
"kindString": "Index signature",
"flags": {},
"parameters": [
{
"id": 33,
"name": "key",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
}
}
}
}
},
{
"id": 34,
"name": "method",
"kind": 1024,
"kindString": "Property",
"flags": {
"isOptional": true
},
"comment": {
"shortText": "The HTTP verb of the request"
},
"sources": [
{
"fileName": "src/types.ts",
"line": 52,
"character": 2
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": "POST"
},
{
"type": "literal",
"value": "GET"
},
{
"type": "literal",
"value": "PUT"
},
{
"type": "literal",
"value": "PATCH"
},
{
"type": "literal",
"value": "DELETE"
}
]
}
}
],
"groups": [
{
"title": "Properties",
"kind": 1024,
"children": [
35,
30,
34
]
}
],
"sources": [
{
"fileName": "src/types.ts",
"line": 44,
"character": 36
}
]
}
}
},
{
"id": 58,
"name": "FunctionsResponse",
"kind": 4194304,
"kindString": "Type alias",
"flags": {},
"sources": [
{
"fileName": "src/types.ts",
"line": 15,
"character": 12
}
],
"typeParameter": [
{
"id": 59,
"name": "T",
"kind": 131072,
"kindString": "Type parameter",
"flags": {}
}
],
"type": {
"type": "union",
"types": [
null,
null
]
}
}
],
"groups": [
{
"title": "Classes",
"kind": 128,
"children": [
1,
36,
43,
48,
53
]
},
{
"title": "Type Aliases",
"kind": 4194304,
"children": [
28,
58
]
}
],
"sources": [
{
"fileName": "src/index.ts",
"line": 1,
"character": 0
}
]
}