Class YAMLOMap

Hierarchy

YAMLSeq
- YAMLOMap

Index

Constructors

Constructors

constructor

new YAMLOMap(): YAMLOMap
Returns YAMLOMap
Overrides YAMLSeq.constructor
- Defined in node_modules/yaml/dist/schema/yaml-1.1/omap.d.ts:6

Properties

[NODE_TYPE]

[NODE_TYPE]: symbol

add

add: ((pair, overwrite?) => void)

Type declaration

- (pair, overwrite?): void
- Parameters
  - pair: Pair<any, any> | {
    key: any;
    value: any;
    }
  - Optional overwrite: boolean
  Returns void

`Optional` anchor

anchor?: string

An optional anchor on this node. Used by alias nodes.

`Optional` comment

comment?: null | string

A comment on or immediately after this

`Optional` commentBefore

commentBefore?: null | string

A comment before this

delete

delete: ((key) => boolean)

Type declaration

- (key): boolean
- Parameters
  - key: unknown
  Returns boolean

`Optional` flow

flow?: boolean

If true, stringify this and all child nodes using flow rather than block styles.

get

get: {
    (key, keepScalar): undefined | Scalar<any>;
    (key, keepScalar?): any;
    (key, keepScalar?): any;
}

Type declaration

- (key, keepScalar): undefined | Scalar<any>
- Parameters
  - key: unknown
  - keepScalar: true
  Returns undefined | Scalar<any>
- (key, keepScalar?): any
- Parameters
  - key: unknown
  - Optional keepScalar: false
  Returns any
- (key, keepScalar?): any
- Parameters
  - key: unknown
  - Optional keepScalar: boolean
  Returns any

has

has: ((key) => boolean)

Type declaration

- (key): boolean
- Parameters
  - key: unknown
  Returns boolean

items

items: unknown[]

`Optional` range

range?: null | Range

The [start, value-end, node-end] character offsets for the part of the source parsed into this node (undefined if not parsed). The value-end and node-end positions are themselves not included in their respective ranges.

schema

schema: undefined | yaml.Schema

set

set: ((key, value) => void)

Type declaration

- (key, value): void
- Parameters
  - key: any
  - value: any
  Returns void

`Optional` spaceBefore

spaceBefore?: boolean

A blank line before this node and its commentBefore

`Optional` srcToken

srcToken?: yaml.CST.Token

The CST token that was composed into this node.

`Optional` tag

tag?: string

A fully qualified tag, if required

`Static` maxFlowStringSingleLineLength

maxFlowStringSingleLineLength: number

`Static` tag

tag: string

Accessors

`Static` tagName

get tagName(): "tag:yaml.org,2002:seq"
Returns "tag:yaml.org,2002:seq"
Inherited from YAMLSeq.tagName
- Defined in node_modules/yaml/dist/nodes/YAMLSeq.d.ts:17

Methods

addIn

addIn(path, value): void
Adds a value to the collection. For !!map and !!omap the value must be a Pair instance or a { key, value } object, which may not have a key that already exists in the map.
Parameters
- path: Iterable<unknown>
- value: unknown
Returns void
Inherited from YAMLSeq.addIn
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:51

clone

clone(schema?): Collection
Create a copy of this collection.
Parameters
- Optional schema: yaml.Schema
  If defined, overwrites the original's schema
Returns Collection
Inherited from YAMLSeq.clone
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:23

deleteIn

deleteIn(path): boolean
Removes a value from the collection.
Parameters
- path: Iterable<unknown>
Returns boolean
true if the item was found and removed.
Inherited from YAMLSeq.deleteIn
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:56

getIn

getIn(path, keepScalar?): unknown
Returns item at key, or undefined if not found. By default unwraps scalar values from their surrounding node; to disable set keepScalar to true (collections are always returned intact).
Parameters
- path: Iterable<unknown>
- Optional keepScalar: boolean
Returns unknown
Inherited from YAMLSeq.getIn
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:62

hasAllNullValues

hasAllNullValues(allowScalar?): boolean
Parameters
- Optional allowScalar: boolean
Returns boolean
Inherited from YAMLSeq.hasAllNullValues
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:63

hasIn

hasIn(path): boolean
Checks if the collection includes a value with the key key.
Parameters
- path: Iterable<unknown>
Returns boolean
Inherited from YAMLSeq.hasIn
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:67

setIn

setIn(path, value): void
Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.
Parameters
- path: Iterable<unknown>
- value: unknown
Returns void
Inherited from YAMLSeq.setIn
- Defined in node_modules/yaml/dist/nodes/Collection.d.ts:72

toJSON

toJSON(_?, ctx?): unknown[]
If ctx is given, the return type is actually Map<unknown, unknown>, but TypeScript won't allow widening the signature of a child method.
Parameters
- Optional _: unknown
- Optional ctx: ToJSContext
Returns unknown[]
Overrides YAMLSeq.toJSON
- Defined in node_modules/yaml/dist/schema/yaml-1.1/omap.d.ts:23

toString

toString(ctx?, onComment?, onChompKeep?): string
Parameters
- Optional ctx: StringifyContext
- Optional onComment: (() => void)
  - - (): void
    - Returns void
- Optional onChompKeep: (() => void)
  - - (): void
    - Returns void
Returns string
Inherited from YAMLSeq.toString
- Defined in node_modules/yaml/dist/nodes/YAMLSeq.d.ts:57

Class YAMLOMap

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns YAMLOMap

Properties

[NODE_TYPE]

add

Type declaration

Parameters

pair: Pair<any, any> | { key: any; value: any; }

Optional overwrite: boolean

Returns void

Optional anchor

Optional comment

Optional commentBefore

delete

Type declaration

Parameters

key: unknown

Returns boolean

Optional flow

get

Type declaration

Parameters

key: unknown

keepScalar: true

Returns undefined | Scalar<any>

Parameters

key: unknown

Optional keepScalar: false

Returns any

Parameters

key: unknown

Optional keepScalar: boolean

Returns any

has

Type declaration

Parameters

key: unknown

Returns boolean

items

Optional range

schema

set

Type declaration

Parameters

key: any

value: any

Returns void

Optional spaceBefore

Optional srcToken

Optional tag

Static maxFlowStringSingleLineLength

Static tag

Accessors

Static tagName

Returns "tag:yaml.org,2002:seq"

Methods

addIn

Parameters

path: Iterable<unknown>

value: unknown

Returns void

clone

Parameters

Optional schema: yaml.Schema

Returns Collection

deleteIn

Parameters

path: Iterable<unknown>

Returns boolean

getIn

Parameters

path: Iterable<unknown>

pair: Pair<any, any> | {
key: any;
value: any;
}

`Optional` overwrite: boolean

`Optional` anchor

`Optional` comment

`Optional` commentBefore

`Optional` flow

`Optional` keepScalar: false

`Optional` keepScalar: boolean

`Optional` range

`Optional` spaceBefore

`Optional` srcToken

`Optional` tag

`Static` maxFlowStringSingleLineLength

`Static` tag

`Static` tagName

`Optional` schema: yaml.Schema

`Optional` keepScalar: boolean

`Optional` allowScalar: boolean

`Optional` _: unknown

`Optional` ctx: ToJSContext

`Optional` ctx: StringifyContext

`Optional` onComment: (() => void)

`Optional` onChompKeep: (() => void)