开源项目 `is-what` 使用教程

开源项目 is-what 使用教程

is-whatJS type check (TypeScript supported) functions like `isPlainObject() isArray()` etc. A simple & small integration.项目地址:https://gitcode.com/gh_mirrors/is/is-what

1. 项目的目录结构及介绍

is-what/
├── dist/
│   ├── index.d.ts
│   ├── index.js
│   └── index.js.map
├── src/
│   ├── index.ts
│   └── types.ts
├── .gitignore
├── .npmignore
├── .prettierrc
├── LICENSE
├── package.json
├── README.md
├── tsconfig.json
└── yarn.lock

• dist/: 编译后的文件目录，包含 TypeScript 声明文件、JavaScript 文件和源映射文件。
• src/: 源代码目录，包含主要的 TypeScript 文件和类型定义文件。
• .gitignore: Git 忽略文件列表。
• .npmignore: npm 忽略文件列表。
• .prettierrc: Prettier 代码格式化配置文件。
• LICENSE: 项目许可证。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 编译配置文件。
• yarn.lock: Yarn 依赖锁定文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts，这是整个项目的入口文件。它导出了项目的主要功能和类型定义。

// src/index.ts
export * from './types';
export { is } from './is';

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的基本信息、依赖和脚本命令。

{
  "name": "is-what",
  "version": "4.0.0",
  "description": "Simple & tiny JavaScript type checking utility",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "keywords": [
    "javascript",
    "typescript",
    "type",
    "check",
    "utility"
  ],
  "author": "Luca Ban - Mesqueeb",
  "license": "MIT",
  "devDependencies": {
    "@types/jest": "^26.0.20",
    "jest": "^26.6.3",
    "prettier": "^2.2.1",
    "ts-jest": "^26.5.1",
    "typescript": "^4.1.3"
  }
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的编译配置文件，定义了编译选项和编译目标。

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "declaration": true,
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src"]
}

通过以上配置，项目可以被正确编译和运行。

is-whatJS type check (TypeScript supported) functions like `isPlainObject() isArray()` etc. A simple & small integration.项目地址:https://gitcode.com/gh_mirrors/is/is-what