@rio-cloud/cdk-v2-constructs 8.4.0 → 8.6.0

package/node_modules/@smithy/util-stream/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/node_modules/@smithy/util-stream/dist-cjs/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBlob = exports.isReadableStream = exports.splitStream = exports.sdkStreamMixin = exports.headStream = exports.getAwsChunkedEncodingStream = exports.createBufferedReadable = exports.createChecksumStream = exports.ChecksumStream = exports.Uint8ArrayBlobAdapter = void 0;
+var serde_1 = require("@smithy/core/serde");
+Object.defineProperty(exports, "Uint8ArrayBlobAdapter", { enumerable: true, get: function () { return serde_1.Uint8ArrayBlobAdapter; } });
+Object.defineProperty(exports, "ChecksumStream", { enumerable: true, get: function () { return serde_1.ChecksumStream; } });
+Object.defineProperty(exports, "createChecksumStream", { enumerable: true, get: function () { return serde_1.createChecksumStream; } });
+Object.defineProperty(exports, "createBufferedReadable", { enumerable: true, get: function () { return serde_1.createBufferedReadable; } });
+Object.defineProperty(exports, "getAwsChunkedEncodingStream", { enumerable: true, get: function () { return serde_1.getAwsChunkedEncodingStream; } });
+Object.defineProperty(exports, "headStream", { enumerable: true, get: function () { return serde_1.headStream; } });
+Object.defineProperty(exports, "sdkStreamMixin", { enumerable: true, get: function () { return serde_1.sdkStreamMixin; } });
+Object.defineProperty(exports, "splitStream", { enumerable: true, get: function () { return serde_1.splitStream; } });
+Object.defineProperty(exports, "isReadableStream", { enumerable: true, get: function () { return serde_1.isReadableStream; } });
+Object.defineProperty(exports, "isBlob", { enumerable: true, get: function () { return serde_1.isBlob; } });

package/node_modules/@smithy/util-stream/dist-es/index.js

@@ -0,0 +1 @@
+export { Uint8ArrayBlobAdapter, ChecksumStream, createChecksumStream, createBufferedReadable, getAwsChunkedEncodingStream, headStream, sdkStreamMixin, splitStream, isReadableStream, isBlob, } from "@smithy/core/serde";

package/node_modules/@smithy/util-stream/dist-types/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @deprecated Use @smithy/core/serde instead.
+ */
+export { Uint8ArrayBlobAdapter, ChecksumStream, createChecksumStream, createBufferedReadable, getAwsChunkedEncodingStream, headStream, sdkStreamMixin, splitStream, isReadableStream, isBlob, } from "@smithy/core/serde";
+export type { ChecksumStreamInit } from "@smithy/core/serde";

package/node_modules/@smithy/util-stream/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@smithy/util-stream",
+  "version": "4.7.9",
+  "scripts": {
+    "build": "yarn g:tsc -p tsconfig.cjs.json && yarn g:tsc -p tsconfig.es.json && yarn g:tsc -p tsconfig.types.json",
+    "build:types": "premove dist-types && yarn g:tsc -p tsconfig.types.json",
+    "clean": "premove dist-cjs dist-es dist-types",
+    "stage-release": "premove .release && yarn pack && mkdir ./.release && tar zxvf ./package.tgz --directory ./.release && rm ./package.tgz"
+  },
+  "main": "./dist-cjs/index.js",
+  "module": "./dist-es/index.js",
+  "types": "./dist-types/index.d.ts",
+  "author": {
+    "name": "AWS SDK for JavaScript Team",
+    "url": "https://aws.amazon.com/sdk-for-javascript/"
+  },
+  "license": "Apache-2.0",
+  "sideEffects": false,
+  "dependencies": {
+    "@smithy/core": "^3.29.4",
+    "tslib": "^2.6.2"
+  },
+  "devDependencies": {
+    "premove": "4.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "dist-*/**"
+  ],
+  "browser": {},
+  "react-native": {},
+  "homepage": "https://github.com/smithy-lang/smithy-typescript/tree/main/packages/util-stream",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/smithy-lang/smithy-typescript.git",
+    "directory": "packages/util-stream"
+  },
+  "typedoc": {
+    "entryPoint": "src/index.ts"
+  },
+  "publishConfig": {
+    "directory": ".release/package"
+  }
+}

package/node_modules/js-yaml/README.md

@@ -7,180 +7,157 @@ JS-YAML - YAML 1.2 parser / writer for JavaScript
 __[Online Demo](https://nodeca.github.io/js-yaml/)__
 
 
-This is an implementation of [YAML](https://yaml.org/), a human-friendly data
-serialization language. Started as [PyYAML](https://pyyaml.org/) port, it was
-completely rewritten from scratch. Now it's very fast, and supports 1.2 spec.
+A fast and complete [YAML](https://yaml.org/) parser and writer for JavaScript.
+Supports both the 1.2 and 1.1 specs, and passes the entire
+[YAML Test Suite](https://github.com/yaml/yaml-test-suite).
 
 
 Installation
 ------------
 
-### YAML module for node.js
-
 ```
 npm install js-yaml
 ```
 
-
-### CLI executable
-
-If you want to inspect your YAML files from CLI, install js-yaml globally:
-
-```
-npm install -g js-yaml
-```
-
-#### Usage
-
-```
-usage: js-yaml [-h] [-v] [-c] [-t] file
-
-Positional arguments:
-  file           File with YAML document(s)
-
-Optional arguments:
-  -h, --help     Show this help message and exit.
-  -v, --version  Show program's version number and exit.
-  -c, --compact  Display errors in compact mode
-  -t, --trace    Show stack trace on error
-```
+Upgrading from v4? See the [v5 migration guide](docs/migrate_v4_to_v5.md).
 
 
 API
 ---
 
-Here we cover the most 'useful' methods. If you need advanced details (creating
-your own tags), see [examples](https://github.com/nodeca/js-yaml/tree/master/examples)
-for more info.
+Here we cover the most useful methods. If you need advanced details (such as
+creating your own tags), see the [examples](examples/) for more info.
 
 ``` javascript
-const yaml = require('js-yaml');
-const fs   = require('fs');
+import { load } from 'js-yaml'
+import { readFileSync } from 'node:fs'
 
 // Get document, or throw exception on error
 try {
-  const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
-  console.log(doc);
+  const doc = load(readFileSync('example.yml', 'utf8'))
+  console.log(doc)
 } catch (e) {
-  console.log(e);
+  console.log(e)
 }
 ```
 
 
 ### load (string [ , options ])
 
-Parses `string` as single YAML document. Returns either a
-plain object, a string, a number, `null` or `undefined`, or throws `YAMLException` on error. By default, does
-not support regexps, functions and undefined.
+Parses `string` as a single YAML document. Throws `YAMLException` on error.
+This function **does not** understand multi-document or empty sources; it throws
+an exception on those.
+
+> [!WARNING]
+> When processing untrusted input, see the
+> [security considerations](docs/safety.md).
 
 options:
 
 - `filename` _(default: null)_ - string to be used as a file path in
   error/warning messages.
-- `onWarning` _(default: null)_ - function to call on warning messages.
-  Loader will call this function with an instance of `YAMLException` for each warning.
-- `schema` _(default: `DEFAULT_SCHEMA`)_ - specifies a schema to use.
-  - `FAILSAFE_SCHEMA` - only strings, arrays and plain objects:
-    https://www.yaml.org/spec/1.2/spec.html#id2802346
-  - `JSON_SCHEMA` - all JSON-supported types:
-    https://www.yaml.org/spec/1.2/spec.html#id2803231
-  - `CORE_SCHEMA` - same as `JSON_SCHEMA`:
-    https://www.yaml.org/spec/1.2/spec.html#id2804923
-  - `DEFAULT_SCHEMA` - all supported YAML types.
-- `json` _(default: false)_ - compatibility with JSON.parse behaviour. If true, then duplicate keys in a mapping will override values rather than throwing an error.
-- `maxDepth` _(default: 100)_ - limits nesting depth for collections.
-- `maxMergeSeqLength` _(default: 20)_ - limits the number of elements in merge
-  (`<<`) sequences.
-
-NOTE: This function **does not** understand multi-document sources, it throws
-exception on those.
-
-NOTE: JS-YAML **does not** support schema-specific tag resolution restrictions.
-So, the JSON schema is not as strictly defined in the YAML specification.
-It allows numbers in any notation, use `Null` and `NULL` as `null`, etc.
-The core schema also has no such restrictions. It allows binary notation for integers.
-
-
-### loadAll (string [, iterator] [, options ])
-
-Same as `load()`, but understands multi-document sources. Applies
-`iterator` to each document if specified, or returns array of documents.
+- `schema` _(default: `CORE_SCHEMA`)_ - specifies a schema to use.
+  - `FAILSAFE_SCHEMA` - only strings, arrays and plain objects.
+  - `JSON_SCHEMA` - all JSON-supported types.
+  - `CORE_SCHEMA` - a superset of `JSON_SCHEMA`, accepting more notations for
+    the same types.
+  - `YAML11_SCHEMA` - adds the legacy YAML 1.1 types (`!!binary`, `!!timestamp`,
+    `!!omap`, `!!pairs`, `!!set`, merge keys `<<`, and the broader 1.1 scalar
+    notations).
+- `json` _(default: false)_ - compatibility with `JSON.parse` behaviour. If
+  `true`, duplicate keys in a mapping override values rather than throwing an
+  error.
+- `maxDepth` _(default: 100)_ - limits the nesting depth for collections (does
+  not take aliases into account).
+- `maxTotalMergeKeys` _(default: 10000)_ - limits the total number of keys
+  processed by merge (`<<`) across one `load()` / `loadAll()` call. Set to `-1`
+  to disable.
+- `maxAliases` _(default: -1)_ - limits the number of alias nodes (`*ref`) per
+  document. Set to `0` to reject all aliases, or to `-1` for no limit.
+
+> [!NOTE]
+>
+> The default `CORE_SCHEMA` comes without the `!!merge` tag. You can easily
+> enable it if needed:
+>
+> ``` javascript
+> import { load, CORE_SCHEMA, mergeTag } from 'js-yaml'
+>
+> load(data, { schema: CORE_SCHEMA.withTags(mergeTag) })
+> ```
+
+> [!WARNING]
+>
+> The default `mapTag` is `{}`-object based and does not allow complex keys
+> (objects, arrays and so on). That's an intentional choice for convenience.
+> Also, non-string scalar keys, such as `null`, numbers or booleans, are
+> converted to strings.
+>
+> In the rare cases where you really need complex keys, use `realMapTag` in the
+> schema instead. It stores any key exactly as provided, at the cost of less
+> convenient access.
+
+See [examples](examples/) for advanced customization approaches.
+
+
+### loadAll (string [, options ])
+
+Same as `load()`, but understands multi-document sources. Returns an array of
+documents.
 
 ``` javascript
-const yaml = require('js-yaml');
+import { loadAll } from 'js-yaml'
 
-yaml.loadAll(data, function (doc) {
-  console.log(doc);
-});
+console.log(loadAll(data))
 ```
 
 
 ### dump (object [ , options ])
 
-Serializes `object` as a YAML document. Uses `DEFAULT_SCHEMA`, so it will
-throw an exception if you try to dump regexps or functions. However, you can
-disable exceptions by setting the `skipInvalid` option to `true`.
+Serializes `object` as a YAML document. By default it can dump every supported
+YAML type, so it throws an exception if you try to dump regexps or functions.
+However, you can disable exceptions by setting the `skipInvalid` option to
+`true`.
 
 options:
 
 - `indent` _(default: 2)_ - indentation width to use (in spaces).
-- `noArrayIndent` _(default: false)_ - when true, will not add an indentation level to array elements
-- `skipInvalid` _(default: false)_ - do not throw on invalid types (like function
-  in the safe schema) and skip pairs and single values with such types.
-- `flowLevel` _(default: -1)_ - specifies level of nesting, when to switch from
-  block to flow style for collections. -1 means block style everwhere
-- `styles` - "tag" => "style" map. Each tag may have own set of styles.
-- `schema` _(default: `DEFAULT_SCHEMA`)_ specifies a schema to use.
+- `flowLevel` _(default: -1)_ - nesting level at which collections switch from
+  block to flow style (`-1` means never).
+- `seqNoIndent` _(default: false)_ - when `true`, does not add an indentation
+  level to array elements, `␣␣- 1` => `- 1`.
+- `seqInlineFirst` _(default: true)_ - when `true`, allows a nested collection
+  to start on the same line after `-`, `-\n  - 1` => `- - 1`.
+- `skipInvalid` _(default: false)_ - do not throw on invalid types (such as a
+  function in the schema). Invalid mapping pairs and sequence items are skipped;
+  `undefined` sequence items are serialized as `null`.
+- `schema` _(default: a `YAML11_SCHEMA`-based schema)_ - specifies a schema to
+  use.
 - `sortKeys` _(default: `false`)_ - if `true`, sort keys when dumping YAML. If a
   function, use the function to sort the keys.
-- `lineWidth` _(default: `80`)_ - set max line width. Set `-1` for unlimited width.
-- `noRefs` _(default: `false`)_ - if `true`, don't convert duplicate objects into references
-- `noCompatMode` _(default: `false`)_ - if `true` don't try to be compatible with older
-  yaml versions. Currently: don't quote "yes", "no" and so on, as required for YAML 1.1
-- `condenseFlow` _(default: `false`)_ - if `true` flow sequences will be condensed, omitting the space between `a, b`. Eg. `'[a,b]'`, and omitting the space between `key: value` and quoting the key. Eg. `'{"a":b}'` Can be useful when using yaml for pretty URL query params as spaces are %-encoded.
-- `quotingType` _(`'` or `"`, default: `'`)_ - strings will be quoted using this quoting style. If you specify single quotes, double quotes will still be used for non-printable characters.
-- `forceQuotes` _(default: `false`)_ - if `true`, all non-key strings will be quoted even if they normally don't need to.
-- `replacer` - callback `function (key, value)` called recursively on each key/value in source object (see `replacer` docs for `JSON.stringify`).
-
-The following table show availlable styles (e.g. "canonical",
-"binary"...) available for each tag (.e.g. !!null, !!int ...). Yaml
-output is shown on the right side after `=>` (default setting) or `->`:
-
-``` none
-!!null
-  "canonical"   -> "~"
-  "lowercase"   => "null"
-  "uppercase"   -> "NULL"
-  "camelcase"   -> "Null"
-  "empty"       -> ""
-
-!!int
-  "binary"      -> "0b1", "0b101010", "0b1110001111010"
-  "octal"       -> "0o1", "0o52", "0o16172"
-  "decimal"     => "1", "42", "7290"
-  "hexadecimal" -> "0x1", "0x2A", "0x1C7A"
-
-!!bool
-  "lowercase"   => "true", "false"
-  "uppercase"   -> "TRUE", "FALSE"
-  "camelcase"   -> "True", "False"
-
-!!float
-  "lowercase"   => ".nan", '.inf'
-  "uppercase"   -> ".NAN", '.INF'
-  "camelcase"   -> ".NaN", '.Inf'
-```
+- `lineWidth` _(default: `80`)_ - sets the max line width. Set `-1` for unlimited
+  width.
+- `noRefs` _(default: `false`)_ - if `true`, don't convert duplicate objects into
+  references; inline them instead.
+- `quoteStyle` _(`single` or `double`, default: `single`)_ - quoting style to use
+  when a string needs quotes.
+- `forceQuotes` _(default: `false`)_ - if `true`, quote all non-key strings,
+  using `quoteStyle`.
+- `flowBracketPadding` _(default: `false`)_ - add spaces inside flow collection
+  brackets, `{a: 1}` => `{ a: 1 }`.
+- `flowSkipCommaSpace` _(default: `false`)_ - omit the space after commas in
+  flow collections, `[1, 2]` => `[1,2]`.
+- `flowSkipColonSpace` _(default: `false`)_ - omit the space after `:` in flow
+  mappings, `{a: 1}` => `{a:1}`.
+- `quoteFlowKeys` _(default: `false`)_ - quote flow mapping keys, `{a: 1}` =>
+  `{"a": 1}`.
+- `tagBeforeAnchor` _(default: `false`)_ - print an explicit tag before an
+  anchor, `&ref_0 !!set` => `!!set &ref_0`.
+- `transform` - a function `(documents: Document[]) => void` that can mutate the
+  generated AST before it is rendered.
+
+See [examples](examples/) for advanced customization approaches.
 
-Example:
-
-``` javascript
-dump(object, {
-  'styles': {
-    '!!null': 'canonical' // dump null as ~
-  },
-  'sortKeys': true        // sort object keys
-});
-```
 
 Supported YAML types
 --------------------
@@ -191,41 +168,44 @@ The list of standard YAML tags and corresponding JavaScript types. See also
 
 ```
 !!null ''                   # null
-!!bool 'yes'                # bool
+!!bool 'true'               # bool
 !!int '3...'                # number
 !!float '3.14...'           # number
-!!binary '...base64...'     # buffer
-!!timestamp 'YYYY-...'      # date
-!!omap [ ... ]              # array of key-value pairs
-!!pairs [ ... ]             # array or array pairs
-!!set { ... }               # array of objects with given keys and null values
 !!str '...'                 # string
 !!seq [ ... ]               # array
-!!map { ... }               # object
+!!map { ... }               # object (or Map)
+```
+
+The types below are only available in `YAML11_SCHEMA` (not in the default
+`CORE_SCHEMA`):
+
+```
+!!binary '...base64...'     # Uint8Array
+!!timestamp 'YYYY-...'      # date
+!!set { ... }               # Set
+
+# Legacy YAML 1.1 compatibility only; these types cannot be dumped.
+!!omap [ ... ]              # array of key-value pairs
+!!pairs [ ... ]             # array of array pairs
 ```
 
+To preserve complex keys in the first position of a `!!pairs` item, replace
+the default object-based map with `realMapTag` in the schema.
+
 **JavaScript-specific tags**
 
 See [js-yaml-js-types](https://github.com/nodeca/js-yaml-js-types) for
 extra types.
 
 
-Caveats
--------
+CLI
+---
 
-Note, that you use arrays or objects as key in JS-YAML. JS does not allow objects
-or arrays as keys, and stringifies (by calling `toString()` method) them at the
-moment of adding them.
+This can be useful sometimes for a quick check.
 
-``` yaml
----
-? [ foo, bar ]
-: - baz
-? { foo: bar }
-: - baz
-  - baz
 ```
-
-``` javascript
-{ "foo,bar": ["baz"], "[object Object]": ["baz", "baz"] }
+npx js-yaml -h
 ```
+
+Note: the CLI script comes with minimal options, and there are no big plans to
+extend it.