mirror of
https://github.com/dawidd6/action-ansible-playbook.git
synced 2025-12-09 14:20:42 -07:00
node_modules: upgrade
This commit is contained in:
81
node_modules/yaml/README.md
generated
vendored
81
node_modules/yaml/README.md
generated
vendored
@@ -24,60 +24,103 @@ To install:
|
||||
|
||||
```sh
|
||||
npm install yaml
|
||||
# or
|
||||
deno add jsr:@eemeli/yaml
|
||||
```
|
||||
|
||||
**Note:** These docs are for `yaml@2`. For v1, see the [v1.10.0 tag](https://github.com/eemeli/yaml/tree/v1.10.0) for the source and [eemeli.org/yaml/v1](https://eemeli.org/yaml/v1/) for the documentation.
|
||||
|
||||
The development and maintenance of this library is [sponsored](https://github.com/sponsors/eemeli) by:
|
||||
|
||||
<p align="center" width="100%">
|
||||
<a href="https://www.scipress.io/"
|
||||
><img
|
||||
width="150"
|
||||
align="top"
|
||||
src="https://eemeli.org/yaml/images/scipress.svg"
|
||||
alt="Scipress"
|
||||
/></a>
|
||||
|
||||
<a href="https://manifest.build/"
|
||||
><img
|
||||
width="150"
|
||||
align="top"
|
||||
src="https://eemeli.org/yaml/images/manifest.svg"
|
||||
alt="Manifest"
|
||||
/></a>
|
||||
</p>
|
||||
|
||||
## API Overview
|
||||
|
||||
The API provided by `yaml` has three layers, depending on how deep you need to go: [Parse & Stringify](https://eemeli.org/yaml/#parse-amp-stringify), [Documents](https://eemeli.org/yaml/#documents), and the underlying [Lexer/Parser/Composer](https://eemeli.org/yaml/#parsing-yaml).
|
||||
The first has the simplest API and "just works", the second gets you all the bells and whistles supported by the library along with a decent [AST](https://eemeli.org/yaml/#content-nodes), and the third lets you get progressively closer to YAML source, if that's your thing.
|
||||
|
||||
```js
|
||||
import { parse, stringify } from 'yaml'
|
||||
// or
|
||||
import YAML from 'yaml'
|
||||
// or
|
||||
const YAML = require('yaml')
|
||||
```
|
||||
A [command-line tool](https://eemeli.org/yaml/#command-line-tool) is also included.
|
||||
|
||||
### Parse & Stringify
|
||||
|
||||
```js
|
||||
import { parse, stringify } from 'yaml'
|
||||
```
|
||||
|
||||
- [`parse(str, reviver?, options?): value`](https://eemeli.org/yaml/#yaml-parse)
|
||||
- [`stringify(value, replacer?, options?): string`](https://eemeli.org/yaml/#yaml-stringify)
|
||||
|
||||
### Documents
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
```js
|
||||
import {
|
||||
Document,
|
||||
isDocument,
|
||||
parseAllDocuments,
|
||||
parseDocument
|
||||
} from 'yaml'
|
||||
```
|
||||
|
||||
- [`Document`](https://eemeli.org/yaml/#documents)
|
||||
- [`constructor(value, replacer?, options?)`](https://eemeli.org/yaml/#creating-documents)
|
||||
- [`#anchors`](https://eemeli.org/yaml/#working-with-anchors)
|
||||
- [`#contents`](https://eemeli.org/yaml/#content-nodes)
|
||||
- [`#directives`](https://eemeli.org/yaml/#stream-directives)
|
||||
- [`#errors`](https://eemeli.org/yaml/#errors)
|
||||
- [`#warnings`](https://eemeli.org/yaml/#errors)
|
||||
- [`isDocument(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
|
||||
- [`isDocument(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
|
||||
- [`parseAllDocuments(str, options?): Document[]`](https://eemeli.org/yaml/#parsing-documents)
|
||||
- [`parseDocument(str, options?): Document`](https://eemeli.org/yaml/#parsing-documents)
|
||||
|
||||
### Content Nodes
|
||||
|
||||
- [`isAlias(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
|
||||
- [`isCollection(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
|
||||
- [`isMap(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
|
||||
- [`isNode(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
|
||||
- [`isPair(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
|
||||
- [`isScalar(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
|
||||
- [`isSeq(foo): boolean`](https://eemeli.org/yaml/#identifying-nodes)
|
||||
<!-- prettier-ignore -->
|
||||
```js
|
||||
import {
|
||||
isAlias, isCollection, isMap, isNode,
|
||||
isPair, isScalar, isSeq, Scalar,
|
||||
visit, visitAsync, YAMLMap, YAMLSeq
|
||||
} from 'yaml'
|
||||
```
|
||||
|
||||
- [`isAlias(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
|
||||
- [`isCollection(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
|
||||
- [`isMap(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
|
||||
- [`isNode(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
|
||||
- [`isPair(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
|
||||
- [`isScalar(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
|
||||
- [`isSeq(foo): boolean`](https://eemeli.org/yaml/#identifying-node-types)
|
||||
- [`new Scalar(value)`](https://eemeli.org/yaml/#scalar-values)
|
||||
- [`new YAMLMap()`](https://eemeli.org/yaml/#collections)
|
||||
- [`new YAMLSeq()`](https://eemeli.org/yaml/#collections)
|
||||
- [`doc.createAlias(node, name?): Alias`](https://eemeli.org/yaml/#working-with-anchors)
|
||||
- [`doc.createAlias(node, name?): Alias`](https://eemeli.org/yaml/#creating-nodes)
|
||||
- [`doc.createNode(value, options?): Node`](https://eemeli.org/yaml/#creating-nodes)
|
||||
- [`doc.createPair(key, value): Pair`](https://eemeli.org/yaml/#creating-nodes)
|
||||
- [`visit(node, visitor)`](https://eemeli.org/yaml/#modifying-nodes)
|
||||
- [`visit(node, visitor)`](https://eemeli.org/yaml/#finding-and-modifying-nodes)
|
||||
- [`visitAsync(node, visitor)`](https://eemeli.org/yaml/#finding-and-modifying-nodes)
|
||||
|
||||
### Parsing YAML
|
||||
|
||||
```js
|
||||
import { Composer, Lexer, Parser } from 'yaml'
|
||||
```
|
||||
|
||||
- [`new Lexer().lex(src)`](https://eemeli.org/yaml/#lexer)
|
||||
- [`new Parser(onNewLine?).parse(src)`](https://eemeli.org/yaml/#parser)
|
||||
- [`new Composer(options?).compose(tokens)`](https://eemeli.org/yaml/#composer)
|
||||
@@ -143,5 +186,5 @@ YAML.stringify({ number: 3, plain: 'string', block: 'two\nlines\n' })
|
||||
Browser testing provided by:
|
||||
|
||||
<a href="https://www.browserstack.com/open-source">
|
||||
<img width=200 src="https://eemeli.org/yaml/images/browserstack.svg" />
|
||||
<img width=200 src="https://eemeli.org/yaml/images/browserstack.svg" alt="BrowserStack" />
|
||||
</a>
|
||||
|
||||
Reference in New Issue
Block a user