<commit_before>Swagger Parser API
==========================

Things to Know
---------------------
- [Class methods vs. Instance methods](#class-methods-vs-instance-methods)
- [Callbacks vs. Promises](#callbacks-vs-promises)
- [Circular references](#circular-refs)


Classes & Methods
---------------------

#### [`SwaggerParser`](swagger-parser.md)
- [`api`](swagger-parser.md#api)
- [`$refs`](swagger-parser.md#refs)
- [`validate()`](swagger-parser.md#validateapi-options-callback)
- [`dereference()`](swagger-parser.md#dereferenceapi-options-callback)
- [`bundle()`](swagger-parser.md#bundleapi-options-callback)
- [`parse()`](swagger-parser.md#parseapi-options-callback)
- [`resolve()`](swagger-parser.md#resolveapi-options-callback)

#### [`$Refs`](refs.md)
- [`circular`](refs.md#circular)
- [`paths()`](refs.md#pathstypes)
- [`values()`](refs.md#valuestypes)
- [`exists()`](refs.md#existsref)
- [`get()`](refs.md#getref-options)
- [`set()`](refs.md#setref-value-options)

#### [`YAML`](yaml.md)
- [`parse()`](yaml.md#parsetext)
- [`stringify()`](yaml.md#stringifyvalue)

#### [`Options`](options.md)


### Class methods vs. Instance methods
All of Swagger Parser's methods are available as static (class) methods, and as instance methods.  The static methods simply create a new [`SwaggerParser`](swagger-parser.md) instance and then call the corresponding instance method.  Thus, the following line...

```javascript
SwaggerParser.validate("my-api.yaml");<commit_msg>Made the TOC links more obvious<commit_after>Swagger Parser API
==========================

Things to Know
---------------------
- [Class methods vs. Instance methods](#class-methods-vs-instance-methods)
- [Callbacks vs. Promises](#callbacks-vs-promises)
- [Circular references](#circular-refs)


Classes & Methods
---------------------

#### [The `SwaggerParser` class](swagger-parser.md)
- [`api` property](swagger-parser.md#api)
- [`$refs` property](swagger-parser.md#refs)
- [`validate()` method](swagger-parser.md#validateapi-options-callback)
- [`dereference()` method](swagger-parser.md#dereferenceapi-options-callback)
- [`bundle()` method](swagger-parser.md#bundleapi-options-callback)
- [`parse()` method](swagger-parser.md#parseapi-options-callback)
- [`resolve()` method](swagger-parser.md#resolveapi-options-callback)

#### [The `$Refs` class](refs.md)
- [`circular` property](refs.md#circular)
- [`paths()` method](refs.md#pathstypes)
- [`values()` method](refs.md#valuestypes)
- [`exists()` method](refs.md#existsref)
- [`get()` method](refs.md#getref-options)
- [`set()` method](refs.md#setref-value-options)

#### [The `YAML` object](yaml.md)
- [`parse()` method](yaml.md#parsetext)
- [`stringify()` method](yaml.md#stringifyvalue)

#### [The `Options` object](options.md)


### Class methods vs. Instance methods
All of Swagger Parser's methods are available as static (class) methods, and as instance methods.  The static methods simply create a new [`SwaggerParser`](swagger-parser.md) instance and then call the corresponding instance method.  Thus, the following line...

```javascript
SwaggerParser.validate("my-api.yaml");
{'fraction_non_alphanumeric': 0.22941364947132328, 'fraction_numerical': 0.0, 'mean_word_length': 5.20675944333996, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '176088', 'n_tokens_mistral': 1035, 'n_tokens_neox': 969, 'n_words': 185}