Class Location

Abstraction for a URL or file location.

Hierarchy

Location

Index

Constructors

constructor

Properties

path

Accessors

Methods

Constructors

constructor

new Location(path: string): Location

- Defined in src/location.ts:14
Parameters
- path: string
  
  url or file path (backslashes are replaced with slashes)
Returns Location

Properties

Readonly path

path: string

Accessors

absolute

get absolute(): string

- Defined in src/location.ts:93
Returns string

base

get base(): string

- Defined in src/location.ts:44
Name without extension

Returns string

ext

get ext(): undefined | string

- Defined in src/location.ts:54
Returns undefined | string

isAbsolute

get isAbsolute(): boolean

- Defined in src/location.ts:89
Returns boolean

isUrl

get isUrl(): boolean

- Defined in src/location.ts:85
Returns boolean

isYaml

get isYaml(): boolean

- Defined in src/location.ts:73
Returns boolean

name

get name(): string

- Defined in src/location.ts:37
Returns string

parent

get parent(): undefined | string

- Defined in src/location.ts:31
Undefined if no parent path

Returns undefined | string

scheme

get scheme(): undefined | string

- Defined in src/location.ts:77
Returns undefined | string

timestamp

get timestamp(): undefined | number

- Defined in src/location.ts:65
Returns zero for URLs, undefined if file does not exist

Returns undefined | number

Methods

isChildOf

isChildOf(parent: string): boolean

- Defined in src/location.ts:104
TODO: handle urls

Parameters
- parent: string
Returns boolean

relativeTo

relativeTo(parent: string): string

- Defined in src/location.ts:112
TODO: handle urls

Parameters
- parent: string
Returns string

toString

toString(): string

- Defined in src/location.ts:116
Returns string

Generated using TypeDoc