goetia - v0.1.0

Index

Functions

Functions

compareHash

compareHash(data: unknown, hash: string): boolean

- Defined in utils/crypto.ts:11
Parameters
- data: unknown
- hash: string
Returns boolean

exists

exists(loc: PathLike): Promise<boolean>

- Defined in file.ts:72
STANDARD FS

Parameters
- loc: PathLike
Returns Promise<boolean>

exportJSON

exportJSON(loc: string, data: unknown, readable?: boolean): Promise<void>

- Defined in file.ts:133
Exports a JSON File

Parameters
- loc: string
  
  Path to JSON file.
- data: unknown
  
  JSON object.
- readable: boolean = false
  
  Whether or not to format the file for human readability.
Returns Promise<void>

exportTXT

exportTXT(loc: string, data: string): void

- Defined in file.ts:242
Parameters
- loc: string
- data: string
Returns void

exportXLSX

exportXLSX(loc: string, data: any): Promise<void>

- Defined in file.ts:171
Exports an XLSX File

Parameters
- loc: string
  
  Path to XLSX file
- data: any
  
  Data to write to XLSX file
Returns Promise<void>

exportXML

exportXML(loc: string, data: Element | ElementCompact): Promise<void>

- Defined in file.ts:225
Exports an XML File

Parameters
- loc: string
  
  Path to XML file
- data: Element | ElementCompact
  
  JSON object
Returns Promise<void>

generateChecksum

generateChecksum(data: unknown, algorithm?: string): string

- Defined in utils/crypto.ts:3
Parameters
- data: unknown
- algorithm: string = 'md5'
Returns string

getExtension

getExtension(filename: string): undefined | string

- Defined in file.ts:56
Functions

Parameters
- filename: string
Returns undefined | string

importCSV

importCSV(loc: string): Promise<string[][]>

- Defined in file.ts:185
Imports a CSV File

Parameters
- loc: string
  
  Path to CSV file
Returns Promise<string[][]>
CSV data as an array of arrays

importJSON

importJSON<T>(loc: PathLike): Promise<T>

- Defined in file.ts:123
Imports a JSON File

Type parameters
- T
Parameters
- loc: PathLike
  
  Path to JSON file
Returns Promise<T>
JSON object

importTXT

importTXT(loc: string): Promise<string>

- Defined in file.ts:238
Imports a TXT File

Parameters
- loc: string
  
  Path to TXT file
Returns Promise<string>
TXT Data

importXLSX

importXLSX<T>(loc: string, json?: boolean): Promise<WorkSheet | XLSXJSON<T>>

- Defined in file.ts:151
Imports an XLSX File

Type parameters
- T
Parameters
- loc: string
  
  Path to XLSX file
- json: boolean = true
  
  Whether to return JSON object
Returns Promise<WorkSheet | XLSXJSON<T>>
A XLSX Workbook or a JSON object { [key: sheet]: data }.

importXML

importXML(loc: string, options?: XML2JSON): Promise<Element>

- Defined in file.ts:213
Imports an XML File

Parameters
- loc: string
  
  Path to XML file
- options: XML2JSON = defaultOptsXML
  
  Options for xml2json
Returns Promise<Element>
JSON object

makeDir

makeDir(loc: PathLike, dirName?: string): Promise<PathLike>

- Defined in file.ts:81
Makes a new directory and returns its path.

Parameters
- loc: PathLike
  
  The location to make the directory.
- Optional dirName: string
  
  Optional name of the directory to create. If not defined the location will be used.
Returns Promise<PathLike>

removeDir

removeDir(loc: PathLike, dirName?: string): Promise<string>

- Defined in file.ts:92
Removes a directory and returns the resulting location.

Parameters
- loc: PathLike
  
  The location of the directory to remove.
- Optional dirName: string
  
  Optional name of the directory to remove. If not defined the location will be used.
Returns Promise<string>

Generated using TypeDoc