# oas-schema-walker

> Library to walk OAS 3 schema objects and call a callback

Latest version **1.1.5** (published 2020-07-31) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install oas-schema-walker
pnpm add oas-schema-walker
yarn add oas-schema-walker
bun add oas-schema-walker
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.5 |
| Published | 2020-07-31 |
| First published | 2018-06-27 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 747 |
| Author | Mike Ralphson |
| Maintainers | mermade |
| Keywords | openapi, swagger, oas, schema, json-schema |

## Links

- npm: https://www.npmjs.com/package/oas-schema-walker
- Repository: https://github.com/Mermade/oas-kit
- Homepage: https://github.com/Mermade/oas-kit#readme
- Issues: https://github.com/mermade/oas-kit/issues
- Funding: https://github.com/Mermade/oas-kit?sponsor=1
- npm.io page: https://npm.io/package/oas-schema-walker

## Alternatives

- [update-check](https://npm.io/package/update-check.md) — 4.0M weekly downloads
- [react-native-onesignal](https://npm.io/package/react-native-onesignal.md) — 134.5K weekly downloads
- [react-redux-toastr](https://npm.io/package/react-redux-toastr.md) — 33.7K weekly downloads
- [@nocobase/plugin-notification-manager](https://npm.io/package/@nocobase/plugin-notification-manager.md) — 2.0K weekly downloads
- [react-simple-toasts](https://npm.io/package/react-simple-toasts.md) — 1.9K weekly downloads

## Recent versions

- 1.1.5 (latest) — 2020-07-31
- 1.1.4 — 2020-03-31
- 1.1.3 — 2020-03-08
- 1.1.2 — 2019-01-06
- 1.1.1 — 2018-12-14
- 1.1.0 — 2018-09-21
- 1.0.4 — 2018-07-04
- 1.0.3 — 2018-06-27
- 1.0.2 — 2018-06-27
- 1.0.1 — 2018-06-27
- 1.0.0 — 2018-06-27

## README

# OAS-Schema-Walker
## Functions

<dl>
<dt><a href="#getDefaultState">getDefaultState()</a> ⇒</dt>
<dd><p>obtains the default starting state for the <code>state</code> object used
by walkSchema</p>
</dd>
<dt><a href="#walkSchema">walkSchema(parent, state, callback,)</a> ⇒</dt>
<dd><p>begins the walk of a schema object, or the <code>state</code> object used
by walkSchema</p>
</dd>
</dl>

<a name="getDefaultState"></a>

## getDefaultState() ⇒
obtains the default starting state for the `state` object used
by walkSchema

**Kind**: global function
**Returns**: the state object suitable for use in walkSchema
<a name="walkSchema"></a>

## walkSchema(parent, state, callback,) ⇒
begins the walk of a schema object, or the `state` object used
by walkSchema

**Kind**: global function
**Returns**: the schema object

| Param | Description |
| --- | --- |
| parent | the parent schema, if any. Use empty object if none |
| state | the initial starting state of the walker, usually obtained from `getDefaultState` |
| callback, | a function taking a schema, parent and state to be called on this and all subschemas |

---
_Source: https://npm.io/package/oas-schema-walker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._