• Preparing search index...
  • The search index is not available
Houston Common Library
  • Houston Common Library
  • @45drives/houston-common-lib
  • cockpit
  • file

Function file

  • file(path: string, options?: FileOpenOptions & {
        binary?: false;
        syntax?: undefined;
    }): FileHandle<string>
  • Parameters

    • path: string
    • Optional options: FileOpenOptions & {
          binary?: false;
          syntax?: undefined;
      }

    Returns FileHandle<string>

    • Defined in houston-common-lib/typings/cockpit-typings/cockpit.d.ts:223
  • file(path: string, options: FileOpenOptions & {
        binary: true;
        syntax?: undefined;
    }): FileHandle<Uint8Array>
  • Parameters

    • path: string
    • options: FileOpenOptions & {
          binary: true;
          syntax?: undefined;
      }

    Returns FileHandle<Uint8Array>

    • Defined in houston-common-lib/typings/cockpit-typings/cockpit.d.ts:227
  • file<T>(path: string, options: FileOpenOptions & {
        binary?: false;
        syntax: FileSyntaxObject<T, string>;
    }): FileHandle<T>
  • Type Parameters

    • T

    Parameters

    • path: string
    • options: FileOpenOptions & {
          binary?: false;
          syntax: FileSyntaxObject<T, string>;
      }

    Returns FileHandle<T>

    • Defined in houston-common-lib/typings/cockpit-typings/cockpit.d.ts:231
  • file<T>(path: string, options: FileOpenOptions & {
        binary: true;
        syntax: FileSyntaxObject<T, Uint8Array>;
    }): FileHandle<T>
  • Type Parameters

    • T

    Parameters

    • path: string
    • options: FileOpenOptions & {
          binary: true;
          syntax: FileSyntaxObject<T, Uint8Array>;
      }

    Returns FileHandle<T>

    • Defined in houston-common-lib/typings/cockpit-typings/cockpit.d.ts:235

Settings

Member Visibility

Theme

Official Cockpit API Documentation
Houston Common Library
  • Loading...

Generated using TypeDoc