Class LocationContext

Hierarchy

LocationContext

Index

Constructors

constructor

Methods

Constructors

constructor

new LocationContext(): LocationContext

Returns LocationContext

Methods

findExist

findExist(...paths: string[]): Promise<string>

- Defined in internal/runners/src/contexts/LocationContext.ts:63
find which input paths is existed

throws
input not found if none of input paths exist

Parameters
- Rest ...paths: string[]
  
  full-path
Returns Promise<string>
first existing path

findExistSync

findExistSync(...paths: string[]): string

- Defined in internal/runners/src/contexts/LocationContext.ts:81
find which input paths is existed

throws
input not found if none of input paths exist

Parameters
- Rest ...paths: string[]
  
  full-path
Returns string
first existing path

isExist

isExist(...args: string[]): Promise<boolean>

- Defined in internal/runners/src/contexts/LocationContext.ts:34
check whether input args is existing

Parameters
- Rest ...args: string[]
  
  paths to join
Returns Promise<boolean>
true if path file/directory is exist

isExistSync

isExistSync(...args: string[]): boolean

- Defined in internal/runners/src/contexts/LocationContext.ts:47
check whether input args is existing

Parameters
- Rest ...args: string[]
  
  array path that will join to single path
Returns boolean
true if path file/directory is exist

join

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

- Defined in internal/runners/src/contexts/LocationContext.ts:24
mirror path.join()

Parameters
- Rest ...args: string[]
  
  paths to join
Returns string

readFirst

readFirst(...paths: string[]): Promise<string>

- Defined in internal/runners/src/contexts/LocationContext.ts:98
read first existing input file content

throws
input not found if none of input paths exist

Parameters
- Rest ...paths: string[]
  
  list of full-path
Returns Promise<string>
first file content

readFirstSync

readFirstSync(...paths: string[]): Promise<string>

- Defined in internal/runners/src/contexts/LocationContext.ts:111
read first existing input file content

throws
input not found if none of input paths exist

Parameters
- Rest ...paths: string[]
  
  list of full-path
Returns Promise<string>
first file content

Generated using TypeDoc