File: index.d.ts

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (74 lines) | stat: -rw-r--r-- 1,698 bytes parent folder | download
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
/*
* @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 Object = require( './../../ctor' );

/**
* Interface describing the `object` namespace.
*/
interface Namespace {
	/**
	* Returns an object.
	*
	* ## Notes
	*
	* -   If provided `null` or `undefined`, the function returns an empty object.
	* -   If provided an existing object, the function returns the input value unchanged.
	* -   Otherwise, if provided any other value (e.g., a number, string, etc), the function will return an object of the corresponding type.
	*
	* @param value - input value
	* @returns object
	*
	* @example
	* var o = new ns.Object( null );
	* // returns {}
	*
	* @example
	* var o = new ns.Object( 5.0 );
	* // returns <Number>
	*
	* @example
	* var o = new ns.Object( 'beep' );
	* // returns <String>
	*
	* @example
	* var o1 = {};
	*
	* var o2 = new ns.Object( o1 );
	* // returns {}
	*
	* var bool = ( o1 === o2 );
	* // returns true
	*/
	Object: typeof Object;
}

/**
* Object.
*/
declare var ns: Namespace;


// EXPORTS //

export = ns;