Skip to content

Commit

Permalink
Split build command, update README API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
garrettjstevens committed Dec 15, 2021
1 parent 54fc688 commit fda9f27
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ Parser options

Text encoding of the input GFF3. default 'utf8'

Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
Type: BufferEncoding

#### parseFeatures

Expand Down Expand Up @@ -281,9 +281,9 @@ parsed items.
#### Parameters

- `str` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** GFF3 string
- `inputOptions` **[ParseOptions](#parseoptions)** Parsing options (optional, default `{}`)
- `inputOptions` **({encoding: BufferEncoding?, bufferSize: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?} | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))?** Parsing options

Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<GFF3Item>** array of parsed features, directives, comments and/or sequences
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<(GFF3Feature | GFF3Sequence)>** array of parsed features, directives, comments and/or sequences

### formatSync

Expand Down
10 changes: 6 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,17 @@
"scripts": {
"test": "jest",
"clean": "rimraf dist esm",
"coverage": "npm test -- --coverage",
"coverage": "npm-run-all \"test -- --coverage\"",
"lint": "eslint src test",
"docs": "npm-run-all docs:*",
"docs:api": "documentation readme src/api.ts --section=API --shallow",
"docs:util": "documentation readme src/util.ts --section=util --shallow",
"docs:format": "prettier --write README.md",
"prebuild": "npm run clean",
"build": "tsc --target es2018 --outDir esm && tsc --target es5 --outDir dist",
"prepublishOnly": "npm test && npm run build",
"prebuild": "npm-run-all clean",
"build:esm": "tsc --target es2018 --outDir esm",
"build:es5": "tsc --target es5 --outDir dist",
"build": "npm-run-all --parallel build:*",
"prepublishOnly": "npm-run-all test build",
"postpublish": "git push origin master --follow-tags"
},
"keywords": [
Expand Down

0 comments on commit fda9f27

Please sign in to comment.