YAML.YAMLSeq | /deps.ts | aether@v0.0.3

namespace YAML.YAMLSeq

import { YAML } from "https://deno.land/x/aether@v0.0.3/deps.ts";
const { YAMLSeq } = YAML;

class YAML.YAMLSeq

extends Collection

import { YAML } from "https://deno.land/x/aether@v0.0.3/deps.ts";
const { YAMLSeq } = YAML;

Constructors

new

YAMLSeq(schema?: Schema)

Type Parameters

optional

T = unknown

Properties

items: T[]

Methods

add(value: T): void

delete(key: unknown): boolean

Removes a value from the collection.

key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

get(key: unknown, keepScalar: true): Scalar<T> | undefined

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).

key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

get(key: unknown, keepScalar?: false): T | undefined

get(key: unknown, keepScalar?: boolean): T | Scalar<T> | undefined

has(key: unknown): boolean

Checks if the collection includes a value with the key key.

key must contain a representation of an integer for this to succeed. It may be wrapped in a Scalar.

set(key: unknown, value: T): void

Sets a value in this collection. For !!set, value needs to be a boolean to add/remove the item from the set.

If key does not contain a representation of an integer, this will throw. It may be wrapped in a Scalar.

toJSON(_?: unknown, ctx?: ToJSContext): unknown[]

toString(

ctx?: StringifyContext,

onComment?: () => void,

onChompKeep?: () => void,

): string

Static Properties

readonly

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