@ecomplus/utils
Version:
JS utility functions to E-Com Plus (not only) related apps
27 lines • 1.57 kB
TypeScript
export default specTextValue;
/**
* @method
* @memberof ecomUtils
* @name specTextValue
* @description Parse specifications array of nested objects to string.
* @param {Object.<string, *>|Array} product - Product body or array of variation objects
* @param {string} gridId - Grid ID string such as 'color'
* @param {Array} [grids] - List of grid objects
* @param {string} [delimiter=', '] - Delimiter between each specification
* @returns {Array|null}
*
* @example
* const product = { 'name': 'Cruzeiro 2019', 'variations': [ { 'name': 'Cruzeiro 2019 / P / azul', 'specifications': { 'colors': [ { 'text': 'azul', 'value': '#3300ff' }, { 'text': 'vermelho', 'value': '#ff0000' } ] } } ] }
* const gridId = 'colors'
* const delimiter = ','
* const grid1 = { 'grid_id': 'size', 'title': 'Tamanho', 'options': [ { 'text': 'P', 'option_id': 'pp' } ] }
* const grid2 = { 'title': 'Cores', 'grid_id': 'colors', 'options': [ { 'text': 'vermelho', 'option_id': 'vermelho', 'colors': [ '#ff0000' ] }, { 'text': 'azul', 'option_id': 'azul', 'colors': [ '#3300ff' ] } ] }
* const grid3 = { 'title': 'Conector', 'grid_id': 'conector', 'options': [ { 'text': 'USB', 'option_id': 'usb' } ] }
* const grids = [ grid1, grid2, grid3 ]
* ecomUtils.specValues(product, gridId, grids, delimiter)
* // => [{text: 'vermelho', value: '#ff0000'}, {text: 'azul', value: '#3300ff'}]
*/
declare function specTextValue(product: {
[x: string]: any;
} | any[], gridId: string, grids?: any[], delimiter?: string): any[] | null;
//# sourceMappingURL=spec-text-value.d.ts.map