All files / lib/range set.js

100% Statements 80/80
100% Branches 11/11
100% Functions 1/1
100% Lines 80/80

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 76 77 78 79 80 8113x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 21x 21x 21x 12x 12x 9x 9x 9x 9x 9x 9x 9x 15x 8x 8x 8x 8x 8x 21x 13x 13x 13x 13x 13x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 isDeepEqual = require( '@stdlib/assert/deep-equal' );
var isCollection = require( '@stdlib/assert/is-collection' );
var isUndefined = require( '@stdlib/assert/is-undefined' );
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
var isObject = require( '@stdlib/assert/is-object' );
var copyArray = require( '@stdlib/array/base/copy' );
var copy = require( '@stdlib/utils/copy' );
var format = require( '@stdlib/string/format' );
var changeEvent = require( './../change_event.js' );
var prop = require( './properties.js' );
 
 
// VARIABLES //
 
var debug = logger( 'vega:scale:set:'+prop.name );
 
 
// MAIN //
 
/**
* Sets the scale range.
*
* ## Notes
*
* -   Providing `undefined` "unsets" the configured value.
*
* @private
* @param {(Collection|Object|Signal|string|void)} value - input value
* @throws {TypeError} must be either an array-like object, an object, a signal, or a string
* @returns {void}
*/
function set( value ) {
	var isArr = isCollection( value );
	if ( !isArr && !isObject( value ) && !isString( value ) && !isUndefined( value ) ) {
		throw new TypeError( format( 'invalid assignment. `%s` must be either an array-like object, an object, a signal, or a string. Value: `%s`.', prop.name, value ) );
	}
 
	// FIXME: should we verify whether a string is a scale range default? TODO: we should create a package for scale range defaults, along with an associated assertion package
 
	// FIXME: can we do further validation of objects (e.g., data reference or signal reference)?
 
	// FIXME: can we be more intelligent about deep equality comparison here in order to squeeze out some perf? E.g., by doing type specific deep equality comparisons or would that just be replicating what deep equal is doing?
 
	if ( !isDeepEqual( value, this[ prop.private ] ) ) {
		value = ( isArr ) ? copyArray( value ) : copy( value );
		debug( 'Current value: %s. New value: %s.', JSON.stringify( this[ prop.private ] ), JSON.stringify( value ) );
		this[ prop.private ] = value;
		this.emit( 'change', changeEvent( prop.name ) );
	}
}
 
 
// EXPORTS //
 
module.exports = set;