Commit 07f2ed3

committed

chore(readme): refactor usage example with await and destructure all available properties

1 parent 9153a60 commit 07f2ed3Copy full SHA for 07f2ed3

File tree

1 file changed

-8

lines changed

README.md

1 file changed

-8

lines changed

`‎README.md‎`

Lines changed: 8 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -55,8 +55,8 @@ Using [Bun](https://bun.sh/):`
`55`	`55`	```javascript
`56`	`56`	`import { parseHydraDocumentation } from "@api-platform/api-doc-parser";`
`57`	`57`
`58`		`-parseHydraDocumentation("https://demo.api-platform.com").then(({ api }) =>`
`59`		`- console.log(api),`
	`58`	`+const{ api, response, status } =awaitparseHydraDocumentation(`
	`59`	`+ "https://demo.api-platform.com",`
`60`	`60`	`);`
`61`	`61`	```
`62`	`62`
`@@ -65,8 +65,8 @@ parseHydraDocumentation("https://demo.api-platform.com").then(({ api }) =>`
`65`	`65`	```javascript
`66`	`66`	`import { parseSwaggerDocumentation } from "@api-platform/api-doc-parser";`
`67`	`67`
`68`		`-parseSwaggerDocumentation("https://demo.api-platform.com/docs.json").then(`
`69`		`- ({ api }) =>console.log(api),`
	`68`	`+const { api, response, status } =awaitparseSwaggerDocumentation(`
	`69`	`+ "https://demo.api-platform.com/docs.json",`
`70`	`70`	`);`
`71`	`71`	```
`72`	`72`
`@@ -75,18 +75,18 @@ parseSwaggerDocumentation("https://demo.api-platform.com/docs.json").then(`
`75`	`75`	```javascript
`76`	`76`	`import { parseOpenApi3Documentation } from "@api-platform/api-doc-parser";`
`77`	`77`
`78`		`-parseOpenApi3Documentation(`
	`78`	`+const { api, response, status } =awaitparseOpenApi3Documentation(`
`79`	`79`	`"https://demo.api-platform.com/docs.jsonopenapi?spec_version=3.0.0",`
`80`		`-).then(({ api }) =>console.log(api));`
	`80`	`+);`
`81`	`81`	```
`82`	`82`
`83`	`83`	`GraphQL`
`84`	`84`
`85`	`85`	```javascript
`86`	`86`	`import { parseGraphQl } from "@api-platform/api-doc-parser";`
`87`	`87`
`88`		`-parseGraphQl("https://demo.api-platform.com/graphql").then(({ api }) =>`
`89`		`- console.log(api),`
	`88`	`+const{ api, response } =awaitparseGraphQl(`
	`89`	`+ "https://demo.api-platform.com/graphql",`
`90`	`90`	`);`
`91`	`91`	```
`92`	`92`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit 07f2ed3

File tree

1 file changed

1 file changed

`‎README.md‎`

0 commit comments