Class CliFileWriter

Index

Constructors

constructor

Methods

cache revert write cache revert write

Constructors

constructor

new CliFileWriter(): CliFileWriter
Returns CliFileWriter

Methods

cache

cache(filepath: string): Promise<void>
Parameters
- filepath: string
Returns Promise<void>
- Defined in src/cli/CliFileWriter.ts:41

revert

revert(): Promise<void>
Returns Promise<void>
- Defined in src/cli/CliFileWriter.ts:33

write

write(
    filepath: string,
    contents: string,
    opts?:
        | BufferEncoding
        | ObjectEncodingOptions & {
            flag?: OpenMode | undefined;
            flush?: boolean;
            mode?: Mode | undefined;
        } & Abortable
        | null,
): Promise<void>
Parameters
- filepath: string
- contents: string
- Optionalopts:
      | BufferEncoding
      | ObjectEncodingOptions & {
          flag?: OpenMode | undefined;
          flush?: boolean;
          mode?: Mode | undefined;
      } & Abortable
      | null
  - BufferEncoding
  - ObjectEncodingOptions & {
        flag?: OpenMode | undefined;
        flush?: boolean;
        mode?: Mode | undefined;
    } & Abortable
    Optionalflag?: OpenMode | undefined
    Optionalflush?: boolean
    If all data is successfully written to the file, and flush is true, filehandle.sync() is used to flush the data.
    
    Default
    false
    
    Optionalmode?: Mode | undefined
  - null
Returns Promise<void>
- Defined in src/cli/CliFileWriter.ts:23

`Static`cache

cache(filepath: string): Promise<void>
Parameters
- filepath: string
Returns Promise<void>
- Defined in src/cli/CliFileWriter.ts:17

`Static`revert

revert(): Promise<void>
Returns Promise<void>
- Defined in src/cli/CliFileWriter.ts:13

`Static`write

write(
    filepath: string,
    contents: string,
    opts?:
        | BufferEncoding
        | ObjectEncodingOptions & {
            flag?: OpenMode | undefined;
            flush?: boolean;
            mode?: Mode | undefined;
        } & Abortable
        | null,
): Promise<void>
Parameters
- filepath: string
- contents: string
- Optionalopts:
      | BufferEncoding
      | ObjectEncodingOptions & {
          flag?: OpenMode | undefined;
          flush?: boolean;
          mode?: Mode | undefined;
      } & Abortable
      | null
  - BufferEncoding
  - ObjectEncodingOptions & {
        flag?: OpenMode | undefined;
        flush?: boolean;
        mode?: Mode | undefined;
    } & Abortable
    Optionalflag?: OpenMode | undefined
    Optionalflush?: boolean
    If all data is successfully written to the file, and flush is true, filehandle.sync() is used to flush the data.
    
    Default
    false
    
    Optionalmode?: Mode | undefined
  - null
Returns Promise<void>
- Defined in src/cli/CliFileWriter.ts:5

Class CliFileWriter

Index

Constructors

Methods

Constructors

constructor

Returns CliFileWriter

Methods

cache

Parameters

Returns Promise<void>

revert

Returns Promise<void>

write

Parameters

`Optional`flag?: OpenMode | undefined

`Optional`flush?: boolean

Default

`Optional`mode?: Mode | undefined

Returns Promise<void>

`Static`cache

Parameters

Returns Promise<void>

`Static`revert

Returns Promise<void>

`Static`write

Parameters

`Optional`flag?: OpenMode | undefined

`Optional`flush?: boolean

Default

`Optional`mode?: Mode | undefined

Returns Promise<void>

Settings

On This Page

Class CliFileWriter

Index

Constructors

Methods

Constructors

constructor

Returns CliFileWriter

Methods

cache

Parameters

Returns Promise<void>

revert

Returns Promise<void>

write

Parameters

Optionalflag?: OpenMode | undefined

Optionalflush?: boolean

Default

Optionalmode?: Mode | undefined

Returns Promise<void>

Staticcache

Parameters

Returns Promise<void>

Staticrevert

Returns Promise<void>

Staticwrite

Parameters

Optionalflag?: OpenMode | undefined

Optionalflush?: boolean

Default

Optionalmode?: Mode | undefined

Returns Promise<void>

Settings

On This Page

`Optional`flag?: OpenMode | undefined

`Optional`flush?: boolean

`Optional`mode?: Mode | undefined

`Static`cache

`Static`revert

`Static`write

`Optional`flag?: OpenMode | undefined

`Optional`flush?: boolean

`Optional`mode?: Mode | undefined