{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.57.6", "schemaVersion": 1011, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@jsx", "syntaxKind": "block" }, { "tagName": "@jsxRuntime", "syntaxKind": "block" }, { "tagName": "@jsxFrag", "syntaxKind": "block" }, { "tagName": "@jsxImportSource", "syntaxKind": "block" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true }, "reportUnsupportedHtmlElements": false } }, "kind": "Package", "canonicalReference": "@fgv/ts-http-storage!", "docComment": "/**\n * Reusable HTTP storage services for FileTree-style backends.\n *\n * @packageDocumentation\n */\n", "name": "@fgv/ts-http-storage", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "@fgv/ts-http-storage!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Function", "canonicalReference": "@fgv/ts-http-storage!createStorageRoutes:function(1)", "docComment": "/**\n * Builds storage routes for a Hono app.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function createStorageRoutes(options: " }, { "kind": "Reference", "text": "ICreateStorageRoutesOptions", "canonicalReference": "@fgv/ts-http-storage!ICreateStorageRoutesOptions:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Hono", "canonicalReference": "hono!Hono:class" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/packlets/storage/routes.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createStorageRoutes" }, { "kind": "Class", "canonicalReference": "@fgv/ts-http-storage!FsStorageProvider:class", "docComment": "/**\n * Filesystem-backed implementation of {@link IHttpStorageProvider}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class FsStorageProvider implements " }, { "kind": "Reference", "text": "IHttpStorageProvider", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProvider:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/packlets/storage/fsProvider.ts", "releaseTag": "Public", "isAbstract": false, "name": "FsStorageProvider", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@fgv/ts-http-storage!FsStorageProvider:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `FsStorageProvider` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(rootPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "rootPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!FsStorageProvider#createDirectory:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "createDirectory(itemPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeItem", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "itemPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "createDirectory" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!FsStorageProvider#deleteFile:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "deleteFile(itemPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "itemPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "deleteFile" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!FsStorageProvider#getChildren:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "getChildren(itemPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ReadonlyArray", "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeItem", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem:interface" }, { "kind": "Content", "text": ">>>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 11 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "itemPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "getChildren" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!FsStorageProvider#getFile:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "getFile(itemPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageFileResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageFileResponse:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "itemPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "getFile" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!FsStorageProvider#getItem:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "getItem(itemPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeItem", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "itemPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "getItem" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!FsStorageProvider#saveFile:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "saveFile(itemPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", contents: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", contentType?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageFileResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageFileResponse:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 13 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "itemPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "contents", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "contentType", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "saveFile" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!FsStorageProvider#sync:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "sync(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageSyncResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageSyncResponse:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "sync" } ], "implementsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Class", "canonicalReference": "@fgv/ts-http-storage!FsStorageProviderFactory:class", "docComment": "/**\n * Namespace-aware provider factory backed by filesystem directories.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class FsStorageProviderFactory implements " }, { "kind": "Reference", "text": "IHttpStorageProviderFactory", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProviderFactory:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/packlets/storage/fsProvider.ts", "releaseTag": "Public", "isAbstract": false, "name": "FsStorageProviderFactory", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@fgv/ts-http-storage!FsStorageProviderFactory:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `FsStorageProviderFactory` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "IFsStorageProviderFactoryOptions", "canonicalReference": "@fgv/ts-http-storage!IFsStorageProviderFactoryOptions:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!FsStorageProviderFactory#forNamespace:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "forNamespace(namespace?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IHttpStorageProvider", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProvider:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "namespace", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "forNamespace" } ], "implementsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Class", "canonicalReference": "@fgv/ts-http-storage!HttpStorageService:class", "docComment": "/**\n * Service layer for storage API operations.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class HttpStorageService " } ], "fileUrlPath": "src/packlets/storage/service.ts", "releaseTag": "Public", "isAbstract": false, "name": "HttpStorageService", "preserveMemberOrder": false, "members": [ { "kind": "Constructor", "canonicalReference": "@fgv/ts-http-storage!HttpStorageService:constructor(1)", "docComment": "/**\n * Constructs a new instance of the `HttpStorageService` class\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(providers: " }, { "kind": "Reference", "text": "IHttpStorageProviderFactory", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProviderFactory:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "providers", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!HttpStorageService#createDirectory:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "createDirectory(request: " }, { "kind": "Reference", "text": "IStoragePathRequest", "canonicalReference": "@fgv/ts-http-storage!IStoragePathRequest:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeItem", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "createDirectory" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!HttpStorageService#deleteFile:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "deleteFile(request: " }, { "kind": "Reference", "text": "IStoragePathRequest", "canonicalReference": "@fgv/ts-http-storage!IStoragePathRequest:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "deleteFile" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!HttpStorageService#getChildren:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "getChildren(request: " }, { "kind": "Reference", "text": "IStoragePathRequest", "canonicalReference": "@fgv/ts-http-storage!IStoragePathRequest:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeChildrenResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeChildrenResponse:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "getChildren" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!HttpStorageService#getFile:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "getFile(request: " }, { "kind": "Reference", "text": "IStoragePathRequest", "canonicalReference": "@fgv/ts-http-storage!IStoragePathRequest:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageFileResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageFileResponse:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "getFile" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!HttpStorageService#getItem:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "getItem(request: " }, { "kind": "Reference", "text": "IStoragePathRequest", "canonicalReference": "@fgv/ts-http-storage!IStoragePathRequest:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeItem", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "getItem" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!HttpStorageService#saveFile:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "saveFile(request: " }, { "kind": "Reference", "text": "IStorageWriteFileRequest", "canonicalReference": "@fgv/ts-http-storage!IStorageWriteFileRequest:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageFileResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageFileResponse:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "saveFile" }, { "kind": "Method", "canonicalReference": "@fgv/ts-http-storage!HttpStorageService#sync:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "sync(request: " }, { "kind": "Reference", "text": "IStorageSyncRequest", "canonicalReference": "@fgv/ts-http-storage!IStorageSyncRequest:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageSyncResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageSyncResponse:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "request", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "sync" } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@fgv/ts-http-storage!ICreateStorageRoutesOptions:interface", "docComment": "/**\n * Options for creating storage routes.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ICreateStorageRoutesOptions " } ], "fileUrlPath": "src/packlets/storage/routes.ts", "releaseTag": "Public", "name": "ICreateStorageRoutesOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!ICreateStorageRoutesOptions#logger:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly logger?: " }, { "kind": "Reference", "text": "Logging.ILogger", "canonicalReference": "@fgv/ts-utils!ILogger:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": true, "releaseTag": "Public", "name": "logger", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!ICreateStorageRoutesOptions#providers:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly providers: " }, { "kind": "Reference", "text": "IHttpStorageProviderFactory", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProviderFactory:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "providers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@fgv/ts-http-storage!IFsStorageProviderFactoryOptions:interface", "docComment": "/**\n * Options for creating filesystem-backed storage providers.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IFsStorageProviderFactoryOptions " } ], "fileUrlPath": "src/packlets/storage/fsProvider.ts", "releaseTag": "Public", "name": "IFsStorageProviderFactoryOptions", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IFsStorageProviderFactoryOptions#rootPath:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly rootPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "rootPath", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProvider:interface", "docComment": "/**\n * Provider contract for storage backends. All methods are async to support both filesystem and database backends.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IHttpStorageProvider " } ], "fileUrlPath": "src/packlets/storage/model.ts", "releaseTag": "Public", "name": "IHttpStorageProvider", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProvider#createDirectory:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "createDirectory(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeItem", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "createDirectory" }, { "kind": "MethodSignature", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProvider#deleteFile:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "deleteFile(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "deleteFile" }, { "kind": "MethodSignature", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProvider#getChildren:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "getChildren(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "ReadonlyArray", "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeItem", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem:interface" }, { "kind": "Content", "text": ">>>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 11 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getChildren" }, { "kind": "MethodSignature", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProvider#getFile:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "getFile(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageFileResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageFileResponse:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getFile" }, { "kind": "MethodSignature", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProvider#getItem:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "getItem(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeItem", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getItem" }, { "kind": "MethodSignature", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProvider#saveFile:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "saveFile(path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", contents: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", contentType?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageFileResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageFileResponse:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 7, "endIndex": 13 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "path", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "contents", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "contentType", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": true } ], "name": "saveFile" }, { "kind": "MethodSignature", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProvider#sync:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "sync(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageSyncResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageSyncResponse:interface" }, { "kind": "Content", "text": ">>" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "sync" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProviderFactory:interface", "docComment": "/**\n * Factory for creating namespace-scoped storage providers.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IHttpStorageProviderFactory " } ], "fileUrlPath": "src/packlets/storage/provider.ts", "releaseTag": "Public", "name": "IHttpStorageProviderFactory", "preserveMemberOrder": false, "members": [ { "kind": "MethodSignature", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProviderFactory#forNamespace:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "forNamespace(namespace?: " }, { "kind": "Reference", "text": "StorageNamespace", "canonicalReference": "@fgv/ts-http-storage!StorageNamespace:type" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IHttpStorageProvider", "canonicalReference": "@fgv/ts-http-storage!IHttpStorageProvider:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "namespace", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "forNamespace" } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@fgv/ts-http-storage!IStorageFileResponse:interface", "docComment": "/**\n * Response for reading a file.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IStorageFileResponse " } ], "fileUrlPath": "src/packlets/storage/model.ts", "releaseTag": "Public", "name": "IStorageFileResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageFileResponse#contents:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly contents: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "contents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageFileResponse#contentType:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly contentType?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": true, "releaseTag": "Public", "name": "contentType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageFileResponse#path:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@fgv/ts-http-storage!IStoragePathRequest:interface", "docComment": "/**\n * Request for path-based operations.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IStoragePathRequest " } ], "fileUrlPath": "src/packlets/storage/model.ts", "releaseTag": "Public", "name": "IStoragePathRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStoragePathRequest#namespace:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly namespace?: " }, { "kind": "Reference", "text": "StorageNamespace", "canonicalReference": "@fgv/ts-http-storage!StorageNamespace:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": true, "releaseTag": "Public", "name": "namespace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStoragePathRequest#path:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@fgv/ts-http-storage!IStorageSyncRequest:interface", "docComment": "/**\n * Request for sync operation.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IStorageSyncRequest " } ], "fileUrlPath": "src/packlets/storage/model.ts", "releaseTag": "Public", "name": "IStorageSyncRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageSyncRequest#namespace:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly namespace?: " }, { "kind": "Reference", "text": "StorageNamespace", "canonicalReference": "@fgv/ts-http-storage!StorageNamespace:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": true, "releaseTag": "Public", "name": "namespace", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@fgv/ts-http-storage!IStorageSyncResponse:interface", "docComment": "/**\n * Sync response metadata.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IStorageSyncResponse " } ], "fileUrlPath": "src/packlets/storage/model.ts", "releaseTag": "Public", "name": "IStorageSyncResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageSyncResponse#synced:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly synced: " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "synced", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeChildrenResponse:interface", "docComment": "/**\n * Response for listing children.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IStorageTreeChildrenResponse " } ], "fileUrlPath": "src/packlets/storage/model.ts", "releaseTag": "Public", "name": "IStorageTreeChildrenResponse", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeChildrenResponse#children:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly children: " }, { "kind": "Reference", "text": "ReadonlyArray", "canonicalReference": "!ReadonlyArray:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeItem", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "children", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeChildrenResponse#path:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem:interface", "docComment": "/**\n * Storage tree item metadata.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IStorageTreeItem " } ], "fileUrlPath": "src/packlets/storage/model.ts", "releaseTag": "Public", "name": "IStorageTreeItem", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem#path:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly path: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "path", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly type: " }, { "kind": "Reference", "text": "StorageItemType", "canonicalReference": "@fgv/ts-http-storage!StorageItemType:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@fgv/ts-http-storage!IStorageWriteFileRequest:interface", "docComment": "/**\n * Request for writing file contents.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IStorageWriteFileRequest extends " }, { "kind": "Reference", "text": "IStoragePathRequest", "canonicalReference": "@fgv/ts-http-storage!IStoragePathRequest:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/packlets/storage/model.ts", "releaseTag": "Public", "name": "IStorageWriteFileRequest", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageWriteFileRequest#contents:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly contents: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "contents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@fgv/ts-http-storage!IStorageWriteFileRequest#contentType:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "readonly contentType?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": true, "releaseTag": "Public", "name": "contentType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 2 } ] }, { "kind": "Function", "canonicalReference": "@fgv/ts-http-storage!normalizeRequestPath:function(1)", "docComment": "/**\n * Normalizes a request path to a consistent POSIX format.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function normalizeRequestPath(requestPath: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/packlets/storage/fsProvider.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "requestPath", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "normalizeRequestPath" }, { "kind": "Function", "canonicalReference": "@fgv/ts-http-storage!sanitizeNamespace:function(1)", "docComment": "/**\n * Sanitize namespace path segment.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function sanitizeNamespace(namespace?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Result", "canonicalReference": "@fgv/ts-utils!Result:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/packlets/storage/fsProvider.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "namespace", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "name": "sanitizeNamespace" }, { "kind": "Variable", "canonicalReference": "@fgv/ts-http-storage!storageFileResponse:var", "docComment": "/**\n * Converter for file responses.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "storageFileResponse: " }, { "kind": "Reference", "text": "Converter", "canonicalReference": "@fgv/ts-utils!Converter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageFileResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageFileResponse:interface" }, { "kind": "Content", "text": ">" } ], "fileUrlPath": "src/packlets/storage/converters.ts", "isReadonly": true, "releaseTag": "Public", "name": "storageFileResponse", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@fgv/ts-http-storage!StorageItemType:type", "docComment": "/**\n * Storage item type.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StorageItemType = " }, { "kind": "Content", "text": "'file' | 'directory'" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/packlets/storage/model.ts", "releaseTag": "Public", "name": "StorageItemType", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "TypeAlias", "canonicalReference": "@fgv/ts-http-storage!StorageNamespace:type", "docComment": "/**\n * Namespace identifier for scoped storage.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type StorageNamespace = " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/packlets/storage/model.ts", "releaseTag": "Public", "name": "StorageNamespace", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Variable", "canonicalReference": "@fgv/ts-http-storage!storagePathRequest:var", "docComment": "/**\n * Converter for path-based requests.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "storagePathRequest: " }, { "kind": "Reference", "text": "Converter", "canonicalReference": "@fgv/ts-utils!Converter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStoragePathRequest", "canonicalReference": "@fgv/ts-http-storage!IStoragePathRequest:interface" }, { "kind": "Content", "text": ">" } ], "fileUrlPath": "src/packlets/storage/converters.ts", "isReadonly": true, "releaseTag": "Public", "name": "storagePathRequest", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Variable", "canonicalReference": "@fgv/ts-http-storage!storageSyncRequest:var", "docComment": "/**\n * Converter for sync requests.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "storageSyncRequest: " }, { "kind": "Reference", "text": "Converter", "canonicalReference": "@fgv/ts-utils!Converter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageSyncRequest", "canonicalReference": "@fgv/ts-http-storage!IStorageSyncRequest:interface" }, { "kind": "Content", "text": ">" } ], "fileUrlPath": "src/packlets/storage/converters.ts", "isReadonly": true, "releaseTag": "Public", "name": "storageSyncRequest", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Variable", "canonicalReference": "@fgv/ts-http-storage!storageTreeChildrenResponse:var", "docComment": "/**\n * Converter for children list responses.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "storageTreeChildrenResponse: " }, { "kind": "Reference", "text": "Converter", "canonicalReference": "@fgv/ts-utils!Converter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeChildrenResponse", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeChildrenResponse:interface" }, { "kind": "Content", "text": ">" } ], "fileUrlPath": "src/packlets/storage/converters.ts", "isReadonly": true, "releaseTag": "Public", "name": "storageTreeChildrenResponse", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Variable", "canonicalReference": "@fgv/ts-http-storage!storageTreeItem:var", "docComment": "/**\n * Converter for {@link IStorageTreeItem}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "storageTreeItem: " }, { "kind": "Reference", "text": "Converter", "canonicalReference": "@fgv/ts-utils!Converter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageTreeItem", "canonicalReference": "@fgv/ts-http-storage!IStorageTreeItem:interface" }, { "kind": "Content", "text": ">" } ], "fileUrlPath": "src/packlets/storage/converters.ts", "isReadonly": true, "releaseTag": "Public", "name": "storageTreeItem", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "Variable", "canonicalReference": "@fgv/ts-http-storage!storageWriteFileRequest:var", "docComment": "/**\n * Converter for write-file requests.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "storageWriteFileRequest: " }, { "kind": "Reference", "text": "Converter", "canonicalReference": "@fgv/ts-utils!Converter:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "IStorageWriteFileRequest", "canonicalReference": "@fgv/ts-http-storage!IStorageWriteFileRequest:interface" }, { "kind": "Content", "text": ">" } ], "fileUrlPath": "src/packlets/storage/converters.ts", "isReadonly": true, "releaseTag": "Public", "name": "storageWriteFileRequest", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 5 } } ] } ] }