Interface IAppFilesApi

_apiId

addEventListener

• addEventListener<K extends never>(
      eventType: K,
      listener: EventHandler<{}, K>,
  ): DisposeListener

  Adds an event listener for the specified event type.

  Type Parameters

  • K extends never

  Parameters

  • eventType: K

    The type of event to listen for.
  • listener: EventHandler<{}, K>

    The event listener to add.

  Returns DisposeListener

  A function that can be called to remove the event listener.

deleteFile

• deleteFile(path: string): Promise<void>

  Deletes the file at the specified path.

  Parameters

  • path: string

    The relative path of the file to delete.

  Returns Promise<void>

  A promise that resolves when the file has been deleted.

getFile

• getFile(path: string): Promise<string>

  Retrieves the content of a file at the specified path.

  Parameters

  • path: string

    The relative path of the file to retrieve.

  Returns Promise<string>

  A promise that resolves with the content of the file.

getFiles

• getFiles(filter: string): Promise<string[]>

  Retrieves a list of files matching the given glob filter.

  Parameters

  • filter: string

    The glob pattern to match app files against.

  Returns Promise<string[]>

putFile

• putFile(path: string, content: string): Promise<void>

  Uploads content to a file at the specified path.

  Parameters

  • path: string

    The relative path of the file to upload content to.
  • content: string

    The content to upload to the file.

  Returns Promise<void>

  A promise that resolves when the file has been uploaded.

removeEventListener

• removeEventListener<K extends never>(
      eventType: K,
      listener: EventHandler<{}, K>,
  ): void

  Removes an event listener for the specified event type.

  Type Parameters

  • K extends never

  Parameters

  • eventType: K

    The type of event to remove the listener from.
  • listener: EventHandler<{}, K>

    The event listener to remove.

  Returns void