Cocos Creator Types

TypeScript declaration files extracted from Cocos Creator engine.

Read this in other languages: English | 简体中文

Introduction

Including runtime and editor type declarations.

Usage

1. Install npm package:

npm install @xenon.types/cocos-creator

Unless otherwise specified, the version number of the package corresponds to the engine version.

For example, if you want to install the type package corresponding to Cocos Creator v3.8.0, you can:

npm install @xenon.types/cocos-creator@3.8.0

2. Add the path of @xenon.types to the typeRoots field of compilerOptions in tsconfig.json so that TypeScript can find the type declaration file:

"typeRoots": [
    "./node_modules/@types",
    "./node_modules/@xenon.types",
],

Contributing

To get started contributing to the project, see the Contributing Guide.

License

MIT @ SmallMain