Skip to content

Commit f0c72ce

Browse files
PlaneshifterPlaneshifter
committed
Add main namespace TypeScript definitions
Manually removed imports for types as well as plot + repl, which are not currently available.
1 parent 0d94410 commit f0c72ce

File tree

2 files changed

+269
-0
lines changed

2 files changed

+269
-0
lines changed

‎docs/types/index.d.ts‎

Lines changed: 240 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,240 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2021 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 2.0
20+
21+
/* tslint:disable:max-line-length */
22+
/* tslint:disable:max-file-line-count */
23+
24+
import array = require( '@stdlib/array' );
25+
import assert = require( '@stdlib/assert' );
26+
import bench = require( '@stdlib/bench' );
27+
import bigint = require( '@stdlib/bigint' );
28+
import blas = require( '@stdlib/blas' );
29+
import buffer = require( '@stdlib/buffer' );
30+
import cli = require( '@stdlib/cli' );
31+
import complex = require( '@stdlib/complex' );
32+
import constants = require( '@stdlib/constants' );
33+
import datasets = require( '@stdlib/datasets' );
34+
import error = require( '@stdlib/error' );
35+
import fs = require( '@stdlib/fs' );
36+
import iter = require( '@stdlib/iter' );
37+
import math = require( '@stdlib/math' );
38+
import ml = require( '@stdlib/ml' );
39+
import namespace = require( '@stdlib/namespace' );
40+
import ndarray = require( '@stdlib/ndarray' );
41+
import net = require( '@stdlib/net' );
42+
import nlp = require( '@stdlib/nlp' );
43+
import number = require( '@stdlib/number' );
44+
import os = require( '@stdlib/os' );
45+
import process = require( '@stdlib/process' );
46+
import proxy = require( '@stdlib/proxy' );
47+
import random = require( '@stdlib/random' );
48+
import regexp = require( '@stdlib/regexp' );
49+
import simulate = require( '@stdlib/simulate' );
50+
import stats = require( '@stdlib/stats' );
51+
import streams = require( '@stdlib/streams' );
52+
import strided = require( '@stdlib/strided' );
53+
import string = require( '@stdlib/string' );
54+
import symbol = require( '@stdlib/symbol' );
55+
import time = require( '@stdlib/time' );
56+
import utils = require( '@stdlib/utils' );
57+
58+
/**
59+
* Interface describing the `stdlib` namespace.
60+
*/
61+
interface Namespace {
62+
/**
63+
* Arrays.
64+
*/
65+
array: typeof array;
66+
67+
/**
68+
* Standard assertion utilities.
69+
*/
70+
assert: typeof assert;
71+
72+
bench: typeof bench;
73+
74+
/**
75+
* BigInt.
76+
*/
77+
bigint: typeof bigint;
78+
79+
/**
80+
* Standard library BLAS.
81+
*/
82+
blas: typeof blas;
83+
84+
/**
85+
* Buffer.
86+
*/
87+
buffer: typeof buffer;
88+
89+
/**
90+
* Command-line interface.
91+
*/
92+
cli: typeof cli;
93+
94+
/**
95+
* Complex numbers.
96+
*/
97+
complex: typeof complex;
98+
99+
/**
100+
* Standard library constants.
101+
*/
102+
constants: typeof constants;
103+
104+
/**
105+
* Returns datasets.
106+
*
107+
* @param name - dataset name
108+
* @param options - dataset options
109+
* @throws unsupported/unrecognized dataset name
110+
* @returns dataset
111+
*/
112+
datasets: typeof datasets;
113+
114+
/**
115+
* Errors.
116+
*/
117+
error: typeof error;
118+
119+
/**
120+
* Standard library for interfacing with a fileystem.
121+
*/
122+
fs: typeof fs;
123+
124+
/**
125+
* Standard iterator utilities.
126+
*/
127+
iter: typeof iter;
128+
129+
/**
130+
* Standard math.
131+
*/
132+
math: typeof math;
133+
134+
/**
135+
* Standard library machine learning algorithms.
136+
*/
137+
ml: typeof ml;
138+
139+
/**
140+
* Returns the standard library namespace.
141+
*
142+
* @returns standard library namespace
143+
*/
144+
namespace: typeof namespace;
145+
146+
/**
147+
* Multidimensional arrays.
148+
*/
149+
ndarray: typeof ndarray;
150+
151+
/**
152+
* Standard library networking.
153+
*/
154+
net: typeof net;
155+
156+
/**
157+
* Standard library natural language processing.
158+
*/
159+
nlp: typeof nlp;
160+
161+
/**
162+
* Number.
163+
*/
164+
number: typeof number;
165+
166+
/**
167+
* Standard library OS utilities.
168+
*/
169+
os: typeof os;
170+
171+
/**
172+
* Standard library process utilities.
173+
*/
174+
process: typeof process;
175+
176+
/**
177+
* Proxy.
178+
*/
179+
proxy: typeof proxy;
180+
181+
/**
182+
* Standard library generic random functions.
183+
*/
184+
random: typeof random;
185+
186+
/**
187+
* Standard library regular expressions.
188+
*/
189+
regexp: typeof regexp;
190+
191+
/**
192+
* Standard library simulation utilities.
193+
*/
194+
simulate: typeof simulate;
195+
196+
/**
197+
* Standard library statistical functions.
198+
*/
199+
stats: typeof stats;
200+
201+
/**
202+
* Standard library streams.
203+
*/
204+
streams: typeof streams;
205+
206+
/**
207+
* Strided.
208+
*/
209+
strided: typeof strided;
210+
211+
/**
212+
* Standard library string manipulation functions.
213+
*/
214+
string: typeof string;
215+
216+
/**
217+
* Symbol.
218+
*/
219+
symbol: typeof symbol;
220+
221+
/**
222+
* Standard library time utilities.
223+
*/
224+
time: typeof time;
225+
226+
/**
227+
* Standard utilities.
228+
*/
229+
utils: typeof utils;
230+
}
231+
232+
/**
233+
* Standard library.
234+
*/
235+
declare var ns: Namespace;
236+
237+
238+
// EXPORTS //
239+
240+
export = ns;

‎docs/types/test.ts‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2021 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
/* tslint:disable:no-unused-expression */
20+
21+
import stdlib = require( './index' );
22+
23+
24+
// TESTS //
25+
26+
// The exported value is the expected interface...
27+
{
28+
stdlib; // $ExpectType Namespace
29+
}

0 commit comments

Comments
 (0)