Interface WithValues

URI charge with own value or list items.

Hierarchy

Some
- WithValues
  - Single

Index

Accessors

length meta type value

Methods

at entries get hasValues isList isMap isNone isSingle isSome keys list toString toUC

Accessors

`Abstract` length

get length(): number
The number of items this value has.
- Always 0 for maps and absent charge.
- Always 1 for single-valued charge.
- May be any for ,List lists.
Returns number
Inherited from Some.length
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:51

`Abstract` meta

get meta(): Frozen
Metadata associated with this value.

Returns Frozen
Inherited from Some.meta
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:42

type

get type(): string
Type of this charge value.

undefined when the charge has no value.

Returns string
Overrides Some.type
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:239

value

get value(): null | UcUnknown
Own value of the charge or the value of the first item of the list.

undefined when the charge has no own value, e.g. when it is a map, an empty list, or none.

Returns null | UcUnknown
Overrides Some.value
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:238

Methods

`Abstract` at

at(index): None | Some
Obtains an item charge at the given index.

For single-valued charge, map, and URICharge.None always returns itself for indices 0 and -1, and none for any other index.

For the list returns an URI charge of the item at the given index, or none if there is no such item.
Parameters
- index: number
  
  Zero-based index of the list item to be returned. Negative index counts back from the end of the list — if index < 0, index + array.length is accessed.
Returns None | Some
Target item charge, or none if there is no such item.
Inherited from Some.at
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:109

`Abstract` entries

entries(): IterableIterator<[string, Some]>
Iterates over map entries.

Never iterates for non-map instance.

Returns IterableIterator<[string, Some]>
Iterable iterator of entry key/charge pairs.
Inherited from Some.entries
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:140

`Abstract` get

get(key): None | Some
Obtains a map entry with the given key.

Always returns none for non-map instance.
Parameters
- key: string
  
  Target entry key.
Returns None | Some
Either entry charge, or none if there is no such entry.
Inherited from Some.get
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:131

hasValues

hasValues(): true
Checks whether this charge has own value or at leas one list item.

Returns true
true for single-valued charge and non-empty list.
Overrides Some.hasValues
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:241

`Abstract` isList

isList(): boolean
Checks whether this charge is a list.

Returns boolean
true for any list, including zero-length one; false for everything else.
Inherited from Some.isList
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:86

isMap

isMap(): false
Checks whether this charge is a map.

Returns false
true for any map, including empty one; false for everything else.
Overrides Some.isMap
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:242

isNone

isNone(): false
Checks whether this charge is none.

Returns false
true only for URICharge.none instance.
Inherited from Some.isNone
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:230

`Abstract` isSingle

isSingle(): this is Single
Checks whether this charge is a single-valued one.

Returns this is Single
true for single-valued charges only; false for everything else, including lists with single item.
Inherited from Some.isSingle
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:79

isSome

isSome(): true
Checks whether this charge represents something.

Returns true
true for any charge instance, except URICharge.none instance.
Inherited from Some.isSome
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:231

`Abstract` keys

keys(): IterableIterator<string>
Iterates over map entry keys.

Never iterates for non-map instance.

Returns IterableIterator<string>
Iterable iterator of entry keys.
Inherited from Some.keys
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:149

`Abstract` list

list(): IterableIterator<Some>
Iterates over charge item charges.
- For the list iterates over its items,
- For absent charge never iterates.
- For everything else iterates over the charge instance itself.
Returns IterableIterator<Some>
Iterable iterator over present item charges.
Inherited from Some.list
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:120

toString

toString(): string
Builds string representation of URI charge.

Returns string
String representation.
Inherited from Some.toString
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:164

`Abstract` toUC

toUC(rx, mode): void
Transfers this URI charge to the given receiver.
Parameters
- rx: AllUcrx
  
  Charge receiver.
- mode: UctxMode
  
  Transfer mode.
Returns void
Inherited from Some.toUC
- Defined in ucnot/churi/src/schema/uri-charge/uri-charge.ts:157

Interface WithValues

Hierarchy

Index

Accessors

Methods

Accessors

Abstract length

Returns number

Abstract meta

Returns Frozen

type

Returns string

value

Returns null | UcUnknown

Methods

Abstract at

Parameters

index: number

Returns None | Some

Abstract entries

Returns IterableIterator<[string, Some]>

Abstract get

Parameters

key: string

Returns None | Some

hasValues

Returns true

Abstract isList

Returns boolean

isMap

Returns false

isNone

Returns false

Abstract isSingle

Returns this is Single

isSome

Returns true

Abstract keys

Returns IterableIterator<string>

Abstract list

Returns IterableIterator<Some>

toString

Returns string

Abstract toUC

Parameters

rx: AllUcrx

mode: UctxMode

Returns void

Settings

Member Visibility

Theme

On This Page

`Abstract` length

`Abstract` meta

`Abstract` at

`Abstract` entries

`Abstract` get

`Abstract` isList

`Abstract` isSingle

`Abstract` keys

`Abstract` list

`Abstract` toUC