feat: BREAKING_CHANGE rewrite in typescript #19

popomore · 2023-07-27T06:28:51Z

This Pull Request is rewriting code in Typescript

New Feature

ES Module Import

use default export

import is from 'is-type-of';
is.string('');

compatible with commonjs

const is = require('is-type-of');
const { string } = require('is-type-of');
is.string('');
string('');

use checking method directly, using isString('') is better than string('')

import { isString } from 'is-type-of';
isString('');

Type Guard

Accroding to https://www.typescriptlang.org/docs/handbook/2/narrowing.html, support type checking

const val: unknown = '1';
val.includes('1');    // error: val is of type 'unknown' 
if (isString(val)) {
  val.includes('1');  // success
}

New API

Breaking Change

drop Node 14
Don't depend on core-util-is, isstream

socket-security · 2023-07-27T06:29:45Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
typescript	5.1.6	None	`+0`	40.1 MB	typescript-bot
eslint	8.45.0	eval, filesystem, environment	`+46`	8.8 MB	eslintbot

🚮 Removed packages: tsd@0.28.1

codecov · 2023-07-27T17:06:13Z

Codecov Report

Merging #19 (8c506bb) into master (695bcaf) will not change coverage.
Report is 1 commits behind head on master.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##            master       #19    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files            1         7     +6     
  Lines          125       769   +644     
  Branches        23        81    +58     
==========================================
+ Hits           125       769   +644

Files Changed	Coverage Δ
src/index.ts	`100.00% <100.00%> (ø)`
src/is.ts	`100.00% <100.00%> (ø)`
src/types/external.ts	`100.00% <100.00%> (ø)`
src/types/node.ts	`100.00% <100.00%> (ø)`
src/types/primitive.ts	`100.00% <100.00%> (ø)`
src/types/std.ts	`100.00% <100.00%> (ø)`
src/types/util.ts	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

fengmk2 · 2023-07-28T06:29:20Z

package.json

+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "@types/long": "^5.0.0"


dependencies 不需要加

fengmk2 · 2023-07-28T06:33:32Z

src/types/primitive.ts

+type Primitive = string | number | bigint | boolean | symbol | null | undefined;
+type Nullable = null | undefined;
+
+export function isString(val?: unknown): val is string {


val is string 学习了

断言的时候用 asserts 也很好用，类型确定 https://blog.logrocket.com/assertion-functions-typescript/

src/types/primitive.ts

src/types/util.ts

popomore · 2023-07-28T09:19:09Z

文档也写完了

fengmk2 · 2023-07-28T15:01:31Z

2.0.0 released

[skip ci] ## [2.0.0](v1.4.0...v2.0.0) (2023-07-28) ### ⚠ BREAKING CHANGES * drop Node.js <= 14 ### Features * rewrite in typescript ([#19](#19)) ([58b5703](58b5703))

popomore force-pushed the refactor-ts branch 2 times, most recently from 49e3c5f to 20bd302 Compare July 27, 2023 17:03

feat: BREAKING_CHANGE rewrite in typescript

e02438c

popomore force-pushed the refactor-ts branch from 20bd302 to e02438c Compare July 27, 2023 17:31

popomore requested a review from fengmk2 July 28, 2023 06:06

f

53fe204

fengmk2 added the enhancement label Jul 28, 2023

fengmk2 reviewed Jul 28, 2023

View reviewed changes

package.json Outdated

"typescript": "^5.1.6"

},

"dependencies": {

"@types/long": "^5.0.0"

Copy link

Member

fengmk2 Jul 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dependencies 不需要加

fengmk2 reviewed Jul 28, 2023

View reviewed changes

src/types/primitive.ts Show resolved Hide resolved

fengmk2 reviewed Jul 28, 2023

View reviewed changes

src/types/util.ts Show resolved Hide resolved

popomore added 3 commits July 28, 2023 14:43

f

7262241

f

1589982

f

af47964

popomore changed the title ~~WIP: feat: BREAKING_CHANGE rewrite in typescript~~ feat: BREAKING_CHANGE rewrite in typescript Jul 28, 2023

popomore added 2 commits July 28, 2023 17:20

f

9b30053

f

8c506bb

fengmk2 approved these changes Jul 28, 2023

View reviewed changes

fengmk2 merged commit 58b5703 into master Jul 28, 2023
7 checks passed

fengmk2 deleted the refactor-ts branch July 28, 2023 14:50

fengmk2 pushed a commit that referenced this pull request Jul 28, 2023

Release 2.0.0

2665c7b

[skip ci] ## [2.0.0](v1.4.0...v2.0.0) (2023-07-28) ### ⚠ BREAKING CHANGES * drop Node.js <= 14 ### Features * rewrite in typescript ([#19](#19)) ([58b5703](58b5703))

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: BREAKING_CHANGE rewrite in typescript #19

feat: BREAKING_CHANGE rewrite in typescript #19

popomore commented Jul 27, 2023

socket-security bot commented Jul 27, 2023 •

edited

codecov bot commented Jul 27, 2023 •

edited

fengmk2 Jul 28, 2023

fengmk2 Jul 28, 2023

popomore Jul 28, 2023

popomore commented Jul 28, 2023

fengmk2 commented Jul 28, 2023

feat: BREAKING_CHANGE rewrite in typescript #19

feat: BREAKING_CHANGE rewrite in typescript #19

Conversation

popomore commented Jul 27, 2023

New Feature

ES Module Import

Type Guard

New API

Breaking Change

socket-security bot commented Jul 27, 2023 • edited

codecov bot commented Jul 27, 2023 • edited

Codecov Report

fengmk2 Jul 28, 2023

Choose a reason for hiding this comment

fengmk2 Jul 28, 2023

Choose a reason for hiding this comment

popomore Jul 28, 2023

Choose a reason for hiding this comment

popomore commented Jul 28, 2023

fengmk2 commented Jul 28, 2023

socket-security bot commented Jul 27, 2023 •

edited

codecov bot commented Jul 27, 2023 •

edited