UNPKG

1.96 kBTypeScriptView Raw
1export declare function IsUri(uri: string): boolean;
2/**
3 * Loads a UTF8 string from given URI.
4 */
5export declare function ReadUri(uri: string): Promise<string>;
6export declare function ExistsUri(uri: string): Promise<boolean>;
7/**
8 * Create a 'file:///' URI from given absolute path.
9 * Examples:
10 * - "C:\swagger\storage.yaml" -> "file:///C:/swagger/storage.yaml"
11 * - "/input/swagger.yaml" -> "file:///input/swagger.yaml"
12 */
13export declare function CreateFileOrFolderUri(absolutePath: string): string;
14export declare function CreateFileUri(absolutePath: string): string;
15export declare function CreateFolderUri(absolutePath: string): string;
16export declare function EnsureIsFolderUri(uri: string): string;
17export declare function EnsureIsFileUri(uri: string): string;
18export declare function GetFilename(uri: string): string;
19export declare function GetFilenameWithoutExtension(uri: string): string;
20export declare function ToRawDataUrl(uri: string): string;
21/**
22 * The singularity of all resolving.
23 * With URI as our one data type of truth, this method maps an absolute or relative path or URI to a URI using given base URI.
24 * @param baseUri Absolute base URI
25 * @param pathOrUri Relative/absolute path/URI
26 * @returns Absolute URI
27 */
28export declare function ResolveUri(baseUri: string, pathOrUri: string): string;
29export declare function ParentFolderUri(uri: string): string | null;
30export declare function MakeRelativeUri(baseUri: string, absoluteUri: string): string;
31export declare function EnumerateFiles(folderUri: string, probeFiles?: string[]): Promise<string[]>;
32/**
33 * Writes string to local file system.
34 * @param fileUri Target file uri.
35 * @param data String to write (encoding: UTF8).
36 */
37export declare function WriteString(fileUri: string, data: string): Promise<void>;
38/**
39 * Clears a folder on the local file system.
40 * @param folderUri Folder uri.
41 */
42export declare function ClearFolder(folderUri: string): Promise<void>;