@stdlib/nlp/ordinalize/lib/validate.js

Natural language processing.

/**
* @license Apache-2.0
*
* Copyright (c) 2022 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.
*/

'use strict';

// MODULES //

var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var indexOf = require( '@stdlib/utils/index-of' );
var format = require( '@stdlib/string/format' );


// VARIABLES //

var LANGUAGE_CODES = [ 'en', 'es', 'fin', 'fr', 'de', 'it', 'pt', 'swe' ];
var GRAMMATICAL_GENDERS = [ 'masculine', 'feminine' ];


// MAIN //

/**
* Validates function options.
*
* @private
* @param {Object} opts - destination object
* @param {Options} options - options to validate
* @param {string} [options.lang] - language code
* @param {boolean} [options.suffixOnly] - boolean indicating whether to only return the suffix
* @param {string} [options.gender] - grammatical gender (used if applicable; either 'masculine' or 'feminine')
* @returns {(null|Error)} error object or null
*
* @example
* var opts = {};
* var options = {
*     'lang': 'es'
* };
* var err = validate( opts, options );
* if ( err ) {
*     throw err;
* }
*/
function validate( opts, options ) {
	if ( !isPlainObject( options ) ) {
		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
	}
	if ( hasOwnProp( options, 'lang' ) ) {
		opts.lang = options.lang;
		if ( indexOf( LANGUAGE_CODES, opts.lang ) === -1 ) {
			return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Value: `%s`.', 'lang', LANGUAGE_CODES.join( '", "' ), opts.lang ) );
		}
	}
	if ( hasOwnProp( options, 'suffixOnly' ) ) {
		opts.suffixOnly = options.suffixOnly;
		if ( !isBoolean( opts.suffixOnly ) ) {
			return new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'suffixOnly', opts.suffixOnly ) );
		}
	}
	if ( hasOwnProp( options, 'gender' ) ) {
		opts.gender = options.gender;
		if ( indexOf( GRAMMATICAL_GENDERS, opts.gender ) === -1 ) {
			return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Value: `%s`.', 'gender', GRAMMATICAL_GENDERS.join( '", "' ), opts.gender ) );
		}
	}
	return null;
}


// EXPORTS //

module.exports = validate;