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
|
/*
* @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.
*/
// TypeScript Version: 2.0
/* tslint:disable:max-line-length */
/* tslint:disable:max-file-line-count */
import Boolean = require( './../../ctor' );
/**
* Interface describing the `boolean` namespace.
*/
interface Namespace {
/**
* Returns a boolean.
*
* ## Notes
*
* - When invoked without `new`,
*
* - if provided `false`, `null`, `undefined`, `-0`, `0`, `NaN`, or an empty string, the function returns `false`.
* - if provided any other value, including an empty object, an empty array, the string `'false'`, or a `Boolean` object (including a `Boolean` object whose value is `false`), the function returns `true`.
*
* - When invoked with `new`, the constructor returns a `Boolean` object, which is an object wrapper for a primitive boolean value. The value of the returned `Boolean` object follows the same conversion semantics as when the constructor is invoked without `new`.
*
* @param value - input value
* @returns boolean or boolean object
*
* @example
* var b = ns.Boolean( null );
* // returns false
*
* b = ns.Boolean( [] );
* // returns true
*
* b = ns.Boolean( {} );
* // returns true
*
* @example
* var b = new ns.Boolean( false );
* // returns <ns.Boolean>
*/
Boolean: typeof Boolean;
}
/**
* Boolean.
*/
declare var ns: Namespace;
// EXPORTS //
export = ns;
|