All files / lib/format set.js

100% Statements 75/75
100% Branches 10/10
100% Functions 1/1
100% Lines 75/75

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 7674x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 23x 23x 23x 23x 23x 23x 14x 14x 9x 9x 9x 16x 8x 8x 8x 8x 23x 74x 74x 74x 74x 74x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
/* eslint-disable no-invalid-this */
 
'use strict';
 
// MODULES //
 
var logger = require( 'debug' );
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var isObject = require( '@stdlib/assert/is-object' );
var isUndefined = require( '@stdlib/assert/is-undefined' );
var objectAssignIn = require( '@stdlib/object/assign-in' );
var format = require( '@stdlib/string/format' );
var changeEvent = require( './../change_event.js' );
var prop = require( './properties.js' );
 
 
// VARIABLES //
 
var debug = logger( 'vega:legend:set:'+prop.name );
 
 
// MAIN //
 
/**
* Sets the format specifier for legend labels.
*
* ## Notes
*
* -   Providing `undefined` "unsets" the configured value.
*
* @private
* @param {(string|Object|void)} value - input value
* @throws {TypeError} must be a string or object
* @returns {void}
*/
function set( value ) {
	var isObj = isObject( value );
 
	// FIXME: validate that an object is a valid TimeMultiFormat object
 
	if ( !isString( value ) && !isObj && !isUndefined( value ) ) {
		throw new TypeError( format( 'invalid assignment. `%s` must be a string or a valid format object. Value: `%s`.', prop.name, value ) );
	}
 
	// TODO: consider a deep equality check for format objects in order to avoid false positive change events
 
	if ( value !== this[ prop.private ] ) {
		debug( 'Current value: %s. New value: %s.', JSON.stringify( this[ prop.private ] ), JSON.stringify( value ) );
		this[ prop.private ] = ( isObj ) ? objectAssignIn( {}, value ) : value;
		this.emit( 'change', changeEvent( prop.name ) );
	}
}
 
 
// EXPORTS //
 
module.exports = set;