Schema.Interpolation

// @namespace Schema.Interpolation
import { Schema } from 'rcfm'
const Interpolation = Schema.Interpolation

@typedef {string} Interpolation
@description - 插值符，以 "<< >>" 包裹自定义引用路径

@example
"<< Jerry.son.age >>"

@type {ExceptionInstance}
@description - 不是合规的实例

@prop {string} type = "INVALID_INTERPOLATION"
@prop {string} [name = type]
@prop {Object} [data = {}]
@prop {string} [message]

// Interpolation.isInterpolation(arg)
// @param {*} arg - 任意参数
// @returns {boolean} - 当入参是 Interpolation 时返回 true，否则返回 false

// @examples
Interpolation.isInterpolation("<< James.age >>") // true
Interpolation.isInterpolation({}) // false

// Interpolation.isntInterpolation(arg)
// @param {*} arg - 任意参数
// @returns {boolean} - 当入参是 Interpolation 时返回 false，否则返回 true

// @examples
Interpolation.isntInterpolation("<< James.age >>") // false
Interpolation.isntInterpolation({}) // true

// Interpolation.mustbeInterpolation(arg, message)
// @param {*} arg - 任意参数
// @param {string} [message] - 自定义异常对象消息
// @returns {undefined}

// @examples
Interpolation.mustbeInterpolation("<< James.age >>")
Interpolation.mustbeInterpolation({}) // Throws a INVALID_INTERPOLATION exception.