UNPKG

@mocks-server/admin-api-paths

Version:

Api paths of @mocks-server/plugin-admin-api

38 lines 3.15 kB
{ "name": "@mocks-server/admin-api-paths", "version": "5.0.0", "description": "Api paths of @mocks-server/plugin-admin-api", "keywords": [ "administration", "admin", "api", "rest", "client" ], "author": "Javier Brea", "license": "MIT", "repository": { "type": "git", "url": "https://github.com/mocks-server/main.git", "directory": "packages/admin-api-paths" }, "homepage": "https://www.mocks-server.org", "publishConfig": { "access": "public" }, "files": [ "dist", "dist-tsc" ], "main": "dist/index.cjs.js", "module": "dist/index.esm.js", "types": "dist-tsc/index.d.ts", "engines": { "node": ">=14.x" }, "scripts": { "build": "tsc && rollup --config", "test:unit": "jest" }, "readme": "<p align=\"center\"><a href=\"https://mocks-server.org\" target=\"_blank\" rel=\"noopener noreferrer\"><img width=\"120\" src=\"https://www.mocks-server.org/img/logo_120.png\" alt=\"Mocks Server logo\"></a></p>\n\n<p align=\"center\">\n <a href=\"https://github.com/mocks-server/main/actions?query=workflow%3Abuild+branch%3Amaster\"><img src=\"https://github.com/mocks-server/main/workflows/build/badge.svg?branch=master\" alt=\"Build Status\"></a>\n <a href=\"https://codecov.io/gh/mocks-server/main\"><img src=\"https://codecov.io/gh/mocks-server/main/branch/master/graph/badge.svg?token=2S8ZR55AJV\" alt=\"Coverage\"></a>\n <a href=\"https://sonarcloud.io/project/overview?id=mocks-server_main_admin-api-paths\"><img src=\"https://sonarcloud.io/api/project_badges/measure?project=mocks-server_main_admin-api-paths&metric=alert_status\" alt=\"Quality Gate\"></a>\n <a href=\"https://www.npmjs.com/package/@mocks-server/admin-api-paths\"><img src=\"https://img.shields.io/npm/dm/@mocks-server/admin-api-paths.svg\" alt=\"Downloads\"></a>\n <a href=\"https://renovatebot.com\"><img src=\"https://img.shields.io/badge/renovate-enabled-brightgreen.svg\" alt=\"Renovate\"></a>\n <a href=\"https://github.com/mocks-server/main/blob/master/packages/admin-api-paths/LICENSE\"><img src=\"https://img.shields.io/npm/l/@mocks-server/admin-api-paths.svg\" alt=\"License\"></a>\n</p>\n\n---\n\n# Api paths of the Mocks-Server Plugin Admin Api\n\nConstants defining API paths of the [Mocks Server Plugin Admin API][plugin-admin-api-url]. They can be used to build plugin API clients.\n\n## Installation\n\n```bash\nnpm install --save @mocks-server/admin-api-paths\n```\n\nThe UMD build is also available on unpkg. When UMD package is loaded, it creates a `pluginAdminApiPaths` global object containing all constants.\n\n```html\n<script src=\"https://unpkg.com/@mocks-server/admin-api-paths/dist/index.umd.js\"></script>\n```\n\n## Usage\n\n```js\nimport { BASE_PATH, CONFIG } from \"@mocks-server/admin-api-paths\";\n\nconsole.log(BASE_PATH); // \"/api\"\nconsole.log(CONFIG); // \"/config\"\n```\n\n## Contributing\n\nContributors are welcome.\nPlease read the [contributing guidelines](.github/CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md).\n\n[plugin-admin-api-url]: https://github.com/mocks-server/main/blob/master/packages/admin-api-client\n" }