UNPKG

2.03 kBJSONView Raw
1{
2 "name": "@verdaccio/types",
3 "version": "10.8.0",
4 "description": "verdaccio types definitions",
5 "keywords": [
6 "verdaccio",
7 "typescript",
8 "types"
9 ],
10 "author": "Juan Picado <juanpicado19@gmail.com>",
11 "license": "MIT",
12 "homepage": "https://verdaccio.org",
13 "repository": {
14 "type": "git",
15 "url": "https://github.com/verdaccio/monorepo",
16 "directory": "core/types"
17 },
18 "bugs": {
19 "url": "https://github.com/verdaccio/monorepo/issues"
20 },
21 "publishConfig": {
22 "access": "public"
23 },
24 "main": "build/types.d.ts",
25 "types": "build/types.d.ts",
26 "devDependencies": {
27 "@types/node": "12.12.6",
28 "typedoc": "^0.23.0",
29 "typedoc-plugin-missing-exports": "^0.23.0",
30 "typedoc-umlclass": "^0.7.0"
31 },
32 "funding": {
33 "type": "opencollective",
34 "url": "https://opencollective.com/verdaccio"
35 },
36 "scripts": {
37 "clean": "rimraf ./build",
38 "test": "exit 0",
39 "build": "tsc --emitDeclarationOnly -p tsconfig.json",
40 "docs": "typedoc --options ./typedoc.json --excludeExternals"
41 },
42 "readme": "# Typescript types\n\nTypescript definitions for verdaccio plugins and internal code\n\n## Usage\n\nFor usage with the library, the `tsconfig.json` should looks like this.\n\n```\n//tsconfig.json\n{\n \"compilerOptions\": {\n \"target\": \"esnext\",\n \"module\": \"commonjs\",\n \"declaration\": true,\n \"noImplicitAny\": false,\n \"strict\": true,\n \"outDir\": \"lib\",\n \"allowSyntheticDefaultImports\": true,\n \"esModuleInterop\": true,\n \"typeRoots\": [\n \"./node_modules/@verdaccio/types/lib/verdaccio\",\n \"./node_modules/@types\"\n ]\n },\n \"include\": [\n \"src/*.ts\",\n \"types/*.d.ts\"\n ]\n}\n```\n\n### Example\n\n```typescript\nimport type {ILocalData, LocalStorage, Logger, Config} from '@verdaccio/types';\n\n class LocalData implements ILocalData {\n\n path: string;\n logger: Logger;\n data: LocalStorage;\n config: Config;\n locked: boolean;\n ...\n}\n```\n\n#### Plugins\n"
43}
\No newline at end of file