Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ShellFileQueue

Shell file API.

Hierarchy

  • ShellFileQueue

Index

Properties

Methods

Properties

queue

queue: { clear: any; get: any }

Type declaration

  • clear: function
    • clear(): void

    • Clears the shell file queue.

      Returns void

  • get: function
    • get(): string[]

    • Returns the file queue.

      Returns string[]

Methods

enqueue

  • enqueue(item: String): void

  • Enqueues an item.

    Parameters

    • item: String

      The item to enqueue.

    Returns void

enqueueMany

  • enqueueMany(items: string[]): void

  • Enqueues files in the shell file queue.

    Parameters

    • items: string[]

      The items to enqueue.

    Returns void

reset

  • reset(): void

  • Resets the shell file handler.

    Returns void

sanitize

  • sanitize(): void

  • Removes broken/nonexistent paths in the queue.

    Returns void

setOperation

  • setOperation(name: "copy" | "move"): void

  • Sets the target file manipulation operation for the queue.

    Parameters

    • name: "copy" | "move"

      The name of the operation to use.

    Returns void

Generated using TypeDoc