openapi-path-templating/es/test.mjs

OpenAPI Path Templating parser, validator, resolver and matcher.

import parse from "./parse/index.mjs";
/**
 * Test if a string is a path template.
 *
 * @param {string} pathTemplate
 * @param {Object} [options={}] - An object.
 * @param {boolean} [options.strict=true] - A boolean indicating presence of at least one `template-expression` AST node.
 * @returns {boolean}
 */
const test = (pathTemplate, {
  strict = false
} = {}) => {
  try {
    const parseResult = parse(pathTemplate);
    if (!parseResult.result.success) return false;
    if (!strict) return true;
    const parts = [];
    parseResult.ast.translate(parts);
    return parts.some(([type]) => type === 'template-expression');
  } catch {
    return false;
  }
};
export default test;