Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "types"

Index

Interfaces

Type aliases

Type aliases

BufferConstructor

BufferConstructor: (length: number) => BufferType

Type declaration

DirForeachOptions

DirForeachOptions: { recursive?: undefined | false | true }

Type declaration

  • Optional recursive?: undefined | false | true

    if true will loop recursively

FSWatcher

FSWatcher: { close: any; on: any }

Type declaration

  • close: function
    • close(): void
  • on: function
    • on(event: string, callback: () => void): void

    • Parameters

      • event: string
      • callback: () => void
          • (): void

          • Returns void

      Returns void

PluginData

PluginData<A, B, C>: { className: A; desc?: undefined | string; func: (this: B, ...args: any[]) => any; isStatic: false; methodName: string } | { className: A; desc?: undefined | string; func: (this: C, ...args: any[]) => any; isStatic: true; methodName: string }
@param

C the Class type

Type parameters

  • A

    the className

  • B

    the actual class inst type

  • C

Stats

Stats: StatsBase<number>

TypedArray

TypedArray: Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array

WatchListener

WatchListener: (e: string, path: string) => void

Type declaration

    • (e: string, path: string): void

    • Parameters

      • e: string
      • path: string

      Returns void

fsObjType

fsObjType: { closeSync: (fd: number) => void; mkTempDir: () => string; mkTempFile: () => string; openSync: (path: string, flags?: undefined | string) => number; watch: (path: string, listener?: Function) => FSWatcher; appendFileSync: any; chmodSync: any; copyFileSync: any; existsSync: any; linkSync: any; lstatSync: any; mkdirSync: any; readFileSync: any; readdirSync: any; renameSync: any; rmdirSync: any; statSync: any; symlinkSync: any; truncateSync: any; unlinkSync: any; writeFileSync: any }

Type declaration

  • closeSync: (fd: number) => void
      • (fd: number): void

      • Parameters

        • fd: number

        Returns void

  • mkTempDir: () => string
      • (): string

      • Returns string

  • mkTempFile: () => string
      • (): string

      • Returns string

  • openSync: (path: string, flags?: undefined | string) => number
      • (path: string, flags?: undefined | string): number

      • Parameters

        • path: string
        • Optional flags: undefined | string

        Returns number

  • watch: (path: string, listener?: Function) => FSWatcher
      • (path: string, listener?: Function): FSWatcher

      • Parameters

        • path: string
        • Optional listener: Function

        Returns FSWatcher

  • appendFileSync: function
    • appendFileSync(path: string, data: string | Uint8Array): void
  • chmodSync: function
    • chmodSync(path: string, mode: number | string): void

    • Parameters

      • path: string
      • mode: number | string

      Returns void

  • copyFileSync: function
    • copyFileSync(origin: string, dest: string): void

    • Parameters

      • origin: string
      • dest: string

      Returns void

  • existsSync: function
    • existsSync(path: string): boolean
  • linkSync: function
    • linkSync(existingPath: string, newPath: string): void

    • Parameters

      • existingPath: string
      • newPath: string

      Returns void

  • lstatSync: function
    • lstatSync(path: string): Stats
  • mkdirSync: function
    • mkdirSync(path: string): void
  • readFileSync: function
    • readFileSync(path: string, position?: undefined | number, length?: undefined | number, buffer?: BufferType | TypedArray | DataView, offset?: undefined | number): BufferType

    • Parameters

      • path: string
      • Optional position: undefined | number
      • Optional length: undefined | number
      • Optional buffer: BufferType | TypedArray | DataView
      • Optional offset: undefined | number

      Returns BufferType

  • readdirSync: function
    • readdirSync(path: string): string[]
  • renameSync: function
    • renameSync(oldPath: string, newPath: string): void

    • Parameters

      • oldPath: string
      • newPath: string

      Returns void

  • rmdirSync: function
    • rmdirSync(path: string, options?: undefined | { recursive?: undefined | false | true }): void

    • Parameters

      • path: string
      • Optional options: undefined | { recursive?: undefined | false | true }

      Returns void

  • statSync: function
    • statSync(path: string): Stats
  • symlinkSync: function
    • symlinkSync(existingPath: string, newPath: string): void

    • Parameters

      • existingPath: string
      • newPath: string

      Returns void

  • truncateSync: function
    • truncateSync(path: string, offset?: undefined | number): void

    • Parameters

      • path: string
      • Optional offset: undefined | number

      Returns void

  • unlinkSync: function
    • unlinkSync(path: string): void
  • writeFileSync: function
    • writeFileSync(path: string, data: string | Uint8Array, position?: undefined | number, length?: undefined | number, offset?: undefined | number): void

    • Parameters

      • path: string
      • data: string | Uint8Array
      • Optional position: undefined | number
      • Optional length: undefined | number
      • Optional offset: undefined | number

      Returns void

obj

obj<T>: {}

Type parameters

  • T

Type declaration

  • [key: string]: T

objAny

objAny: obj<unknown>

pathObjType

pathObjType: { join: any; parse: any }

Type declaration

  • join: function
    • join(...paths: string[]): string

    • Parameters

      • Rest ...paths: string[]

      Returns string

  • parse: function
    • parse(p: string): { base: string; dir: string; ext: string; name: string; root: string }

    • Parameters

      • p: string

      Returns { base: string; dir: string; ext: string; name: string; root: string }

      • base: string
      • dir: string
      • ext: string
      • name: string
      • root: string

valueType

valueType: string | BufferType | Uint8Array | number

Generated using TypeDoc