Class PlatformUtils

Platform-specific tools.

Hierarchy

PlatformUtils

Index

Constructors

constructor

Properties

type
workdir

Constructors

constructor

new PlatformUtils(): PlatformUtils

Returns PlatformUtils

Properties

Static type

type: "browser" | "node"

Type of the currently running platform.

Static workdir

workdir: string

Methods

Static basename

basename(pathStr: string): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:53
Returns the basename of a file

Parameters
- pathStr: string
Returns string

Static deleteDirectory

deleteDirectory(dir: string): Promise<{}>

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:87
Parameters
- dir: string
Returns Promise<{}>

Static deleteFile

deleteFile(dir: string, file: string): Promise<{}>

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:86
Parameters
- dir: string
- file: string
Returns Promise<{}>

Static directory

directory(file: string): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:76
Parameters
- file: string
Returns string

Static dirname

dirname(pathStr: string): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:62
Returns the dirname of the file

Parameters
- pathStr: string
Returns string

Static fileExist

fileExist(pathStr: string): boolean

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:49
Synchronously checks if file exist. Does "fs.existsSync".

Parameters
- pathStr: string
Returns boolean

Static filename

filename(pathStr: string): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:58
Returns the filename only (without extension)

Parameters
- pathStr: string
Returns string

Static getEnvVariable

getEnvVariable(name: string): any

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:80
Gets environment variable.

Parameters
- name: string
Returns any

Static getGlobalVariable

getGlobalVariable(): any

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:17
Gets global variable where global stuff can be stored.

Returns any

Static getHostFileContent

getHostFileContent(): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:82
Returns string

Static getHostPath

getHostPath(): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:81
Returns string

Static isAbsolute

isAbsolute(pathStr: string): boolean

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:75
Test if path is absolute.

Parameters
- pathStr: string
Returns boolean

Static isDir

isDir(pathStr: string): boolean

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:45
Parameters
- pathStr: string
Returns boolean

Static isFile

isFile(pathStr: string): boolean

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:44
Parameters
- pathStr: string
Returns boolean

Static join

join(...args: string[]): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:22
Parameters
- Rest ...args: string[]
Returns string

Static load

load(name: string): any

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:27
Loads ("require"-s) given file or package. This operation only supports on node platform

Parameters
- name: string
Returns any

Static mkdir

mkdir(targetDir: string, sep?: string): boolean

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:83
Parameters
- targetDir: string
- Optional sep: string
Returns boolean

Static pathExtname

pathExtname(pathStr: string, dotted?: boolean): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:35
Gets file extension. Does "path.extname".

Parameters
- pathStr: string
- Optional dotted: boolean
Returns string

Static pathNormAndResolve

pathNormAndResolve(pathStr: string): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:43
Resolved given path. Does "path.resolve".

Parameters
- pathStr: string
Returns string

Static pathNormalize

pathNormalize(pathStr: string): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:67
Normalizes given path. Does "path.normalize".

Parameters
- pathStr: string
Returns string

Static pathNormilize

pathNormilize(pathStr: string): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:31
Normalizes given path. Does "path.normalize".

Parameters
- pathStr: string
Returns string

Static pathResolve

pathResolve(pathStr: string): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:39
Resolved given path. Does "path.resolve".

Parameters
- pathStr: string
Returns string

Static pathResolveAndNormalize

pathResolveAndNormalize(pathStr: string): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:71
Normalizes given path. Does "path.normalize".

Parameters
- pathStr: string
Returns string

Static readFile

readFile(filename: string): Promise<Buffer>

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:84
Parameters
- filename: string
Returns Promise<Buffer>

Static readFileSync

readFileSync(filename: string): Buffer

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:85
Parameters
- filename: string
Returns Buffer

Static setWorkDir

setWorkDir(workdir: string): void

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:21
set workdir

Parameters
- workdir: string
Returns void

Static testForFilePath

testForFilePath(path: string): boolean

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:63
Parameters
- path: string
Returns boolean

Static withoutInterpolation

withoutInterpolation(str: string, fn: (str: string) => string): string

- Defined in node_modules/@allgemein/base/utils/PlatformUtils.d.ts:54
Parameters
- str: string
- fn: (str: string) => string
  - - (str: string): string
    - Parameters
      - str: string
      Returns string
Returns string

Generated using TypeDoc