carotte-queue-utils v1.2.0

carotte-queue-utils

Break down REST URL or queue qualifier to get their information

Installation

yarn add carotte-queue-utils

Usage

import { CarotteQueueUtils } from 'carotte-queue-utils';

// Get information about REST URL
const fromUrlResult = CarotteQueueUtils.fromUrl('GET', '/v1/users');
console.log(fromUrlResult);
// {
//   isValid: true,
//   action: null,
//   context: null,
//   version: 1,
//   isBatch: false,
//   resource: {
//     id: null,
//     name: 'users',
//   },
//   amqp: {
//     commonQualifier: 'users.list:v1',
//     prettyQualifier: 'controller.users.list:v1',
//     fullQualifier: 'direct/controller.users.list:v1',
//     type: 'CONTROLLER',
//     verb: 'list',
//   },
//   http: {
//     route: '/v1/users',
//     url: '/v1/users',
//     verb: 'GET',
//   },
// }

// Get information about queue qualifier
const fromQualifierlResult = CarotteQueueUtils.fromQualifier('controller.users.list:v1');
console.log(fromQualifierlResult);
// {
//   isValid: true,
//   action: null,
//   context: null,
//   version: 1,
//   isBatch: false,
//   resource: {
//     id: null,
//     name: 'users',
//   },
//   amqp: {
//     commonQualifier: 'users.list:v1',
//     prettyQualifier: 'controller.users.list:v1',
//     fullQualifier: 'direct/controller.users.list:v1',
//     type: 'CONTROLLER',
//     verb: 'list',
//   },
//   http: {
//     route: '/v1/users',
//     url: '/v1/users',
//     verb: 'GET',
//   },
// }

• commonQualifier:
• prettyQualifier: to display UI
• fullQualifier: technical