Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "Shape"

Index

Classes

Type aliases

Variables

Functions

Type aliases

OldRest

OldRest: { __rest: ShapeObj | ShapeFile | ShapeDir }

Type declaration

ShapeDir

ShapeDir: { filePattern: ShapeFilePattern; name: string; type: 1 }

Type declaration

ShapeFile

ShapeFile: { base: string; defaultContent?: string | BufferType; type: 0; validator?: undefined | ((this: File) => Error[] | void) }

Type declaration

  • base: string
  • Optional defaultContent?: string | BufferType
  • type: 0
  • Optional validator?: undefined | ((this: File) => Error[] | void)

ShapeFilePattern

ShapeFilePattern: { defaultContent?: string | BufferType; regex: RegExp; type: 2; validator?: undefined | ((this: File) => Error[] | void) }

Type declaration

  • Optional defaultContent?: string | BufferType
  • regex: RegExp
  • type: 2
  • Optional validator?: undefined | ((this: File) => Error[] | void)

ShapeObj

ShapeObj: ShapeObjWithoutName & { __computed?: undefined | string }

ShapeObjRest

ShapeObjRest: ShapeObjWithoutName & OldRest

ShapeObjWithoutName

ShapeObjWithoutName: { __computed?: ShapeFilePattern | ShapeObj }

Type declaration

WithRest

WithRest<T>: T & OldRest

Type parameters

createEvents

createEvents: { onCreate?: undefined | ((thing: File | Dir) => void); onCreateDir?: undefined | ((thing: Dir) => void); onCreateFile?: undefined | ((file: File) => void) }

Type declaration

  • Optional onCreate?: undefined | ((thing: File | Dir) => void)
  • Optional onCreateDir?: undefined | ((thing: Dir) => void)
  • Optional onCreateFile?: undefined | ((file: File) => void)

errArr

errArr: { arr: fsProErr[]; push: (err?: fsProErr | errArr) => void }

Type declaration

switchToShapeInstRef

switchToShapeInstRef<T>: {} & { __dir: Dir }

Type parameters

Variables

Const __rest

__rest: unique symbol = Symbol("__rest")

Const name_sym

name_sym: unique symbol = Symbol("__name")

Functions

check

convertPatternToRegex

  • convertPatternToRegex(pattern: string, firstCall: boolean): []

  • Parameters

    • pattern: string
    • firstCall: boolean

    Returns []

convertShapeFileToPattern

createEventRegister

  • createEventRegister(eventsListeners?: createEvents): (Anonymous function)

createShapeInst

errArray

  • errArray(crash: boolean): errArr

Const isErrArr

  • isErrArr(obj?: any): obj is errArr

  • Parameters

    • Optional obj: any

    Returns obj is errArr

Const isShapeDir

  • isShapeDir(obj: any): obj is ShapeDir

Const isShapeFile

  • isShapeFile(obj: any): obj is ShapeFile

Const isShapeFilePattern

  • isShapeFilePattern(obj: any): obj is ShapeFilePattern

  • Parameters

    • obj: any

    Returns obj is ShapeFilePattern

toFileOrDir

  • toFileOrDir(path: string): any

validate

Generated using TypeDoc