@verdaccio/types/package.json

verdaccio types definitions

{
  "name": "@verdaccio/types",
  "version": "10.8.0",
  "description": "verdaccio types definitions",
  "keywords": [
    "verdaccio",
    "typescript",
    "types"
  ],
  "author": "Juan Picado <juanpicado19@gmail.com>",
  "license": "MIT",
  "homepage": "https://verdaccio.org",
  "repository": {
    "type": "git",
    "url": "https://github.com/verdaccio/monorepo",
    "directory": "core/types"
  },
  "bugs": {
    "url": "https://github.com/verdaccio/monorepo/issues"
  },
  "publishConfig": {
    "access": "public"
  },
  "main": "build/types.d.ts",
  "types": "build/types.d.ts",
  "devDependencies": {
    "@types/node": "12.12.6",
    "typedoc": "^0.23.0",
    "typedoc-plugin-missing-exports": "^0.23.0",
    "typedoc-umlclass": "^0.7.0"
  },
  "funding": {
    "type": "opencollective",
    "url": "https://opencollective.com/verdaccio"
  },
  "scripts": {
    "clean": "rimraf ./build",
    "test": "exit 0",
    "build": "tsc --emitDeclarationOnly -p tsconfig.json",
    "docs": "typedoc --options ./typedoc.json --excludeExternals"
  },
  "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"
}