Source: services/route-builder.js

  1. /**
  2.  * Common functions and utilities for tasks related to route building
  3.  *
  4.  * @module
  5.  */
  7. import toArray from '../core/base-service/to-array.js'
  9. /*
  10.  * Factory class for building a BaseService `route` object. This class is useful
  11.  * in complex collections of service classes, when the URL is built
  12.  * conditionally.
  13.  *
  14.  * Patterns based on path-to-regex may obviate the need for this, though they
  15.  * haven't done so yet.
  16.  */
  17. export default class RouteBuilder {
  18.   /**
  19.    * Creates a RouteBuilder object.
  20.    *
  21.    * @param {object} attrs - Refer to individual attributes
  22.    * @param {string} attrs.base - Base URL, defaults to ''
  23.    */
  24.   constructor({ base = '' } = {}) {
  25.     this.base = base
  27.     this._formatComponents = []
  28.     this.capture = []
  29.   }
  31.   /**
  32.    * Get the format components separated by '/'
  33.    *
  34.    * @returns {string} Format components, for example: "format1/format2/format3"
  35.    */
  36.   get format() {
  37.     return this._formatComponents.join('/')
  38.   }
  40.   /**
  41.    * Saves the format and capture values in the RouteBuilder instance.
  42.    *
  43.    * @param {string} format - Pattern based on path-to-regex, for example: (?:(.+)\\.)?${serviceBaseUrl}
  44.    * @param {string} capture - Value to capture
  45.    * @returns {object} RouteBuilder instance for chaining
  46.    */
  47.   push(format, capture) {
  48.     this._formatComponents = this._formatComponents.concat(toArray(format))
  49.     this.capture = this.capture.concat(toArray(capture))
  50.     // Return `this` for chaining.
  51.     return this
  52.   }
  54.   /**
  55.    * Returns a new object based on RouteBuilder instance containing its base, format and capture properties.
  56.    *
  57.    * @returns {object} Object containing base, format and capture properties of the RouteBuilder instance
  58.    */
  59.   toObject() {
  60.     const { base, format, capture } = this
  61.     return { base, format, capture }
  62.   }
  63. }