Class FileValue

A value based on a local file.

Hierarchy

ValueBase<FileValueItem>
- FileValue

Implements

Value

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new FileValue(item: FileValueItem, name?: string, _SCOPE_PROVIDER?: DirectoryScopeProvider): FileValue

Overrides ValueBase.constructor
- Defined in values.ts:270
Initializes a new instance of that class.

Parameters
- item: FileValueItem
  
  The underlying item.
- Optional name: string
- Optional _SCOPE_PROVIDER: DirectoryScopeProvider
Returns FileValue

Properties

Private Optional _SCOPE_PROVIDER

_SCOPE_PROVIDER: DirectoryScopeProvider

item

item: FileValueItem

The underlying item.

othersProvider

othersProvider: ValuesProvider

Gets or sets the function that returns the "other" values.

Accessors

file

get file(): string | false

- Defined in values.ts:292
Gets the full path of the underlying or (false) if it does not exist.

Returns string | false

name

get name(): string

Inherited from ValueBase.name
- Defined in values.ts:189
The name of the value (if available).

inheritdoc

Returns string

others

get others(): Value[]

Inherited from ValueBase.others
- Defined in values.ts:196
Gets the list of "other" values.

Returns Value[]

scopes

get scopes(): string[]

- Defined in values.ts:332
Gets the list of directory scopes.

Returns string[]

value

get value(): any

Overrides ValueBase.value
- Defined in values.ts:363
The value.

inheritdoc

Returns any

Generated using TypeDoc