Skip to content

Commit b65207d

Browse files
authored
Update README.md
Changed documentation to reflect named export in v4
1 parent e7301b7 commit b65207d

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ npm install --save @openapi-contrib/openapi-schema-to-json-schema
3838
Here's a small example to get the idea:
3939

4040
```js
41-
var toJsonSchema = require("@openapi-contrib/openapi-schema-to-json-schema");
41+
var { openapiSchemaToJsonSchema: toJsonSchema } = require("@openapi-contrib/openapi-schema-to-json-schema");
4242

4343
var schema = {
4444
type: "string",
@@ -169,7 +169,7 @@ prints
169169
OpenAPI parameters can be converted:
170170

171171
```js
172-
var toJsonSchema = require("@openapi-contrib/openapi-schema-to-json-schema").fromParameter;
172+
var { fromParameter } = require("@openapi-contrib/openapi-schema-to-json-schema");
173173

174174
var param = {
175175
name: "parameter name",
@@ -180,7 +180,7 @@ var param = {
180180
},
181181
};
182182

183-
var convertedSchema = toJsonSchema(param);
183+
var convertedSchema = fromParameter(param);
184184

185185
console.log(convertedSchema);
186186
```
@@ -247,4 +247,4 @@ This package is [Treeware](https://treeware.earth). If you use it in production,
247247

248248
## Copyright
249249

250-
Copyright 2021 the [OpenAPI Contrib organization](https://github.com/openapi-contrib). Code released under the [MIT License](https://github.com/openapi-contrib/openapi-schema-to-json-schema/blob/main/LICENSE).
250+
Copyright 2023 the [OpenAPI Contrib organization](https://github.com/openapi-contrib). Code released under the [MIT License](https://github.com/openapi-contrib/openapi-schema-to-json-schema/blob/main/LICENSE).

0 commit comments

Comments
 (0)