File overview

Added in v1.0.0

Table of contents

• constructors
  • createFile
• model
  • File (interface)

constructors

createFile

By default files are readonly (isOverwriteable = false).

Signature

export declare const createFile: (path: string, content: string, isOverwriteable?: boolean) => File

Added in v1.0.0

model

File (interface)

Represents a file which can be optionally overwriteable.

Signature

export interface File {
  readonly path: string
  readonly content: string
  readonly isOverwriteable: boolean
}

Added in v1.0.0