Brunobkr/llama.cpp_AlgMor24_github

1JS-YAML - YAML 1.2 parser / writer for JavaScript2=================================================3 4[![CI](https://github.com/nodeca/js-yaml/actions/workflows/ci.yml/badge.svg)](https://github.com/nodeca/js-yaml/actions/workflows/ci.yml)5[![NPM version](https://img.shields.io/npm/v/js-yaml.svg)](https://www.npmjs.org/package/js-yaml)6 7__[Online Demo](https://nodeca.github.io/js-yaml/)__8 9 10This is an implementation of [YAML](https://yaml.org/), a human-friendly data11serialization language. Started as [PyYAML](https://pyyaml.org/) port, it was12completely rewritten from scratch. Now it's very fast, and supports 1.2 spec.13 14 15Installation16------------17 18### YAML module for node.js19 20```21npm install js-yaml22```23 24 25### CLI executable26 27If you want to inspect your YAML files from CLI, install js-yaml globally:28 29```30npm install -g js-yaml31```32 33#### Usage34 35```36usage: js-yaml [-h] [-v] [-c] [-t] file37 38Positional arguments:39  file           File with YAML document(s)40 41Optional arguments:42  -h, --help     Show this help message and exit.43  -v, --version  Show program's version number and exit.44  -c, --compact  Display errors in compact mode45  -t, --trace    Show stack trace on error46```47 48 49API50---51 52Here we cover the most 'useful' methods. If you need advanced details (creating53your own tags), see [examples](https://github.com/nodeca/js-yaml/tree/master/examples)54for more info.55 56``` javascript57const yaml = require('js-yaml');58const fs   = require('fs');59 60// Get document, or throw exception on error61try {62  const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));63  console.log(doc);64} catch (e) {65  console.log(e);66}67```68 69 70### load (string [ , options ])71 72Parses `string` as single YAML document. Returns either a73plain object, a string, a number, `null` or `undefined`, or throws `YAMLException` on error. By default, does74not support regexps, functions and undefined.75 76options:77 78- `filename` _(default: null)_ - string to be used as a file path in79  error/warning messages.80- `onWarning` _(default: null)_ - function to call on warning messages.81  Loader will call this function with an instance of `YAMLException` for each warning.82- `schema` _(default: `DEFAULT_SCHEMA`)_ - specifies a schema to use.83  - `FAILSAFE_SCHEMA` - only strings, arrays and plain objects:84    https://www.yaml.org/spec/1.2/spec.html#id280234685  - `JSON_SCHEMA` - all JSON-supported types:86    https://www.yaml.org/spec/1.2/spec.html#id280323187  - `CORE_SCHEMA` - same as `JSON_SCHEMA`:88    https://www.yaml.org/spec/1.2/spec.html#id280492389  - `DEFAULT_SCHEMA` - all supported YAML types.90- `json` _(default: false)_ - compatibility with JSON.parse behaviour. If true, then duplicate keys in a mapping will override values rather than throwing an error.91- `maxDepth` _(default: 100)_ - limits nesting depth for collections (does not92  take aliasees into account).93- `maxTotalMergeKeys` _(default: 10000)_ - limits the total number of keys94  processed by merge (`<<`) across one `load()` / `loadAll()` call. Set to `-1`95  to disable.96 97NOTE: This function **does not** understand multi-document sources, it throws98exception on those.99 100NOTE: JS-YAML **does not** support schema-specific tag resolution restrictions.101So, the JSON schema is not as strictly defined in the YAML specification.102It allows numbers in any notation, use `Null` and `NULL` as `null`, etc.103The core schema also has no such restrictions. It allows binary notation for integers.104 105 106### loadAll (string [, iterator] [, options ])107 108Same as `load()`, but understands multi-document sources. Applies109`iterator` to each document if specified, or returns array of documents.110 111``` javascript112const yaml = require('js-yaml');113 114yaml.loadAll(data, function (doc) {115  console.log(doc);116});117```118 119 120### dump (object [ , options ])121 122Serializes `object` as a YAML document. Uses `DEFAULT_SCHEMA`, so it will123throw an exception if you try to dump regexps or functions. However, you can124disable exceptions by setting the `skipInvalid` option to `true`.125 126options:127 128- `indent` _(default: 2)_ - indentation width to use (in spaces).129- `noArrayIndent` _(default: false)_ - when true, will not add an indentation level to array elements130- `skipInvalid` _(default: false)_ - do not throw on invalid types (like function131  in the safe schema) and skip pairs and single values with such types.132- `flowLevel` _(default: -1)_ - specifies level of nesting, when to switch from133  block to flow style for collections. -1 means block style everwhere134- `styles` - "tag" => "style" map. Each tag may have own set of styles.135- `schema` _(default: `DEFAULT_SCHEMA`)_ specifies a schema to use.136- `sortKeys` _(default: `false`)_ - if `true`, sort keys when dumping YAML. If a137  function, use the function to sort the keys.138- `lineWidth` _(default: `80`)_ - set max line width. Set `-1` for unlimited width.139- `noRefs` _(default: `false`)_ - if `true`, don't convert duplicate objects into references140- `noCompatMode` _(default: `false`)_ - if `true` don't try to be compatible with older141  yaml versions. Currently: don't quote "yes", "no" and so on, as required for YAML 1.1142- `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.143- `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.144- `forceQuotes` _(default: `false`)_ - if `true`, all non-key strings will be quoted even if they normally don't need to.145- `replacer` - callback `function (key, value)` called recursively on each key/value in source object (see `replacer` docs for `JSON.stringify`).146 147The following table show availlable styles (e.g. "canonical",148"binary"...) available for each tag (.e.g. !!null, !!int ...). Yaml149output is shown on the right side after `=>` (default setting) or `->`:150 151``` none152!!null153  "canonical"   -> "~"154  "lowercase"   => "null"155  "uppercase"   -> "NULL"156  "camelcase"   -> "Null"157  "empty"       -> ""158 159!!int160  "binary"      -> "0b1", "0b101010", "0b1110001111010"161  "octal"       -> "0o1", "0o52", "0o16172"162  "decimal"     => "1", "42", "7290"163  "hexadecimal" -> "0x1", "0x2A", "0x1C7A"164 165!!bool166  "lowercase"   => "true", "false"167  "uppercase"   -> "TRUE", "FALSE"168  "camelcase"   -> "True", "False"169 170!!float171  "lowercase"   => ".nan", '.inf'172  "uppercase"   -> ".NAN", '.INF'173  "camelcase"   -> ".NaN", '.Inf'174```175 176Example:177 178``` javascript179dump(object, {180  'styles': {181    '!!null': 'canonical' // dump null as ~182  },183  'sortKeys': true        // sort object keys184});185```186 187Supported YAML types188--------------------189 190The list of standard YAML tags and corresponding JavaScript types. See also191[YAML tag discussion](https://pyyaml.org/wiki/YAMLTagDiscussion) and192[YAML types repository](https://yaml.org/type/).193 194```195!!null ''                   # null196!!bool 'yes'                # bool197!!int '3...'                # number198!!float '3.14...'           # number199!!binary '...base64...'     # buffer200!!timestamp 'YYYY-...'      # date201!!omap [ ... ]              # array of key-value pairs202!!pairs [ ... ]             # array or array pairs203!!set { ... }               # array of objects with given keys and null values204!!str '...'                 # string205!!seq [ ... ]               # array206!!map { ... }               # object207```208 209**JavaScript-specific tags**210 211See [js-yaml-js-types](https://github.com/nodeca/js-yaml-js-types) for212extra types.213 214 215Caveats216-------217 218Note, that you use arrays or objects as key in JS-YAML. JS does not allow objects219or arrays as keys, and stringifies (by calling `toString()` method) them at the220moment of adding them.221 222``` yaml223---224? [ foo, bar ]225: - baz226? { foo: bar }227: - baz228  - baz229```230 231``` javascript232{ "foo,bar": ["baz"], "[object Object]": ["baz", "baz"] }233```234