amn-ms-common
v1.0.0
Published
Shared code for AMN microservices
Readme
@amn-ms/common
Shared code library for AMN Microservices.
Installation
npm install @amn-ms/commonContents
Errors
CustomError- Base error classBadRequestError- 400 errorsNotAuthorizedError- 401 errorsNotFoundError- 404 errorsRequestValidationError- Validation errors
Middlewares
currentUser- Extract user from JWT tokenrequireAuth- Protect routes (requires authentication)validateRequest- Validate request with express-validatorerrorHandler- Global error handler
Usage
In your microservice:
import {
currentUser,
requireAuth,
errorHandler,
NotFoundError
} from '@amn-ms/common';
// Use middlewares
app.use(currentUser);
app.use('/protected', requireAuth);
app.use(errorHandler);
// Throw errors
throw new NotFoundError();Development
# Install dependencies
npm install
# Build
npm run build
# Watch mode
npm run dev
# Publish (updates version automatically)
npm run pubBuilding
The package is built using TypeScript and outputs to the build/ directory.
Publishing
- Make changes to
src/ - Run
npm run pub(builds, bumps version, publishes) - Or manually:
npm run build && npm publish
