bfx-api-node-models/lib/validators/symbol.js

Object models for usage with the Bitfinex node API

'use strict'

const _includes = require('lodash/includes')
const { SYMBOLS } = require('bfx-hf-util')
const VALID_SYMBOLS = Object.values(SYMBOLS)

/**
 * Validates a symbol
 *
 * @param {*} v - value
 * @returns {string} error - null if valid
 */
module.exports = (v) => (!_includes(VALID_SYMBOLS, v)
  ? 'must be a symbol currently traded on Bitfinex'
  : null
)