Skip to content

Commit 1fc6cd0

Browse files
authored
upgrade typescript & typedoc (#51)
* upgrade typescript & typedoc * use node 16.x instead of 10.x for ci
1 parent a452b5c commit 1fc6cd0

File tree

9 files changed

+7959
-146
lines changed

9 files changed

+7959
-146
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515

1616
strategy:
1717
matrix:
18-
node-version: [10.x, 12.x, 14.x]
18+
node-version: [12.x, 14.x, 16.x]
1919

2020
steps:
2121
- uses: actions/checkout@v1

.npmignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
src
21
docs
32
jest.config.js
43
tsconfig.json

package-lock.json

Lines changed: 7949 additions & 134 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"coverage": "rm -rf coverage && jest --coverage",
1515
"build:esm": "rm -rf ./esm && tsc --module es6 --outDir ./esm",
1616
"build:lib": "rm -rf ./lib && tsc",
17-
"build:doc": "rm -rf ./docs && typedoc",
17+
"build:doc": "rm -rf ./docs && typedoc && cp -r ./assets ./docs",
1818
"build": "npm run build:esm && npm run build:lib",
1919
"prepublishOnly": "npm run test && npm run build",
2020
"ci": "tsc --noEmit && npm run coverage && npm run build && npm run build:doc"
@@ -37,9 +37,9 @@
3737
"jest": "~26.6.1",
3838
"mobx": "^6.0.4",
3939
"ts-jest": "~26.4.2",
40-
"typedoc": "~0.16.11",
40+
"typedoc": "~0.21.6",
4141
"typedoc-twilio-theme": "^1.0.0",
42-
"typescript": "~4.0.3"
42+
"typescript": "~4.1.5"
4343
},
4444
"dependencies": {}
4545
}

src/adapter/index.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { xify, getValue, getValidateStatus, getDirty, getActivated } from '.'
55
const stableDelay = 200 * 2 + 10 // [onChange debounce] + [async validate] + [buffer]
66

77
async function delay(millisecond: number = stableDelay) {
8-
await new Promise(resolve => setTimeout(() => resolve(), millisecond))
8+
await new Promise<void>(resolve => setTimeout(() => resolve(), millisecond))
99
}
1010

1111
describe('xify', () => {

src/fieldState.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const defaultDelay = 10
66
const stableDelay = defaultDelay * 3 // [onChange debounce] + [async validate] + [buffer]
77

88
async function delay(millisecond: number = stableDelay) {
9-
await new Promise(resolve => setTimeout(() => resolve(), millisecond))
9+
await new Promise<void>(resolve => setTimeout(() => resolve(), millisecond))
1010
}
1111

1212
async function delayValue<T>(value: T, millisecond: number = defaultDelay) {

src/formState.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const defaultDelay = 10
77
const stableDelay = defaultDelay * 3 // [onChange debounce] + [async validate] + [buffer]
88

99
async function delay(millisecond: number = stableDelay) {
10-
await new Promise(resolve => setTimeout(() => resolve(), millisecond))
10+
await new Promise<void>(resolve => setTimeout(() => resolve(), millisecond))
1111
}
1212

1313
async function delayValue<T>(value: T, millisecond: number = defaultDelay) {

src/utils.spec.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ import { asyncResponsesAnd, isEmpty, isArrayLike } from './utils'
33

44
const defaultDelay = 10
55

6-
function delay<T>(value?: T, delay: number = defaultDelay + 10): Promise<T> {
7-
return new Promise(
6+
function delay<T>(value?: T, delay: number = defaultDelay + 10): Promise<T | undefined> {
7+
return new Promise<T | undefined>(
88
resolve => setTimeout(() => resolve(value), delay)
99
)
1010
}

typedoc.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
{
2-
"mode": "file",
2+
"packages": ".",
33
"out": "docs",
44
"exclude": "src/utils.ts",
5-
"excludeNotExported": true,
65
"excludePrivate": true,
76
"excludeProtected": true,
87
"theme": "./node_modules/typedoc-twilio-theme/bin"

0 commit comments

Comments
 (0)