Skip to content

Commit 7976761

Browse files
github-actions[bot]kgryte
github-actions[bot]
and
kgryte
authored
Update namespace TypeScript declarations (stdlib-js#543)
Co-authored-by: kgryte <kgryte@users.noreply.github.com>
1 parent 4ebe63d commit 7976761

File tree

152 files changed

+1215
-325
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

152 files changed

+1215
-325
lines changed

‎lib/node_modules/@stdlib/array/base/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818

1919
/* tslint:disable:no-unused-expression */
2020

21-
import base = require( './index' );
21+
import ns = require( './index' );
2222

2323

2424
// TESTS //
2525

2626
// The exported value is the expected interface...
2727
{
28-
base; // $ExpectType Namespace
28+
ns; // $ExpectType Namespace
2929
}

‎lib/node_modules/@stdlib/array/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818

1919
/* tslint:disable:no-unused-expression */
2020

21-
import array = require( './index' );
21+
import ns = require( './index' );
2222

2323

2424
// TESTS //
2525

2626
// The exported value is the expected interface...
2727
{
28-
array; // $ExpectType Namespace
28+
ns; // $ExpectType Namespace
2929
}

‎lib/node_modules/@stdlib/assert/docs/types/index.d.ts‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,13 @@ import isComposite = require( '@stdlib/assert/is-composite' );
113113
import isConfigurableProperty = require( '@stdlib/assert/is-configurable-property' );
114114
import isConfigurablePropertyIn = require( '@stdlib/assert/is-configurable-property-in' );
115115
import isCubeNumber = require( '@stdlib/assert/is-cube-number' );
116+
import isCurrentYear = require( '@stdlib/assert/is-current-year' );
116117
import IS_DARWIN = require( '@stdlib/assert/is-darwin' );
117118
import isDataProperty = require( '@stdlib/assert/is-data-property' );
118119
import isDataPropertyIn = require( '@stdlib/assert/is-data-property-in' );
119120
import isDataView = require( '@stdlib/assert/is-dataview' );
120121
import isDateObject = require( '@stdlib/assert/is-date-object' );
122+
import isDateObjectArray = require( '@stdlib/assert/is-date-object-array' );
121123
import isDigitString = require( '@stdlib/assert/is-digit-string' );
122124
import IS_DOCKER = require( '@stdlib/assert/is-docker' );
123125
import IS_ELECTRON = require( '@stdlib/assert/is-electron' );
@@ -244,6 +246,7 @@ import isSameNativeClass = require( '@stdlib/assert/is-same-native-class' );
244246
import isSameType = require( '@stdlib/assert/is-same-type' );
245247
import isSameValue = require( '@stdlib/assert/is-same-value' );
246248
import isSameValueZero = require( '@stdlib/assert/is-same-value-zero' );
249+
import isSemVer = require( '@stdlib/assert/is-semver' );
247250
import isSharedArrayBuffer = require( '@stdlib/assert/is-sharedarraybuffer' );
248251
import isSkewCentrosymmetricMatrix = require( '@stdlib/assert/is-skew-centrosymmetric-matrix' );
249252
import isSkewPersymmetricMatrix = require( '@stdlib/assert/is-skew-persymmetric-matrix' );
@@ -1615,10 +1618,14 @@ interface Namespace {
16151618
* // returns true
16161619
*
16171620
* @example
1621+
* var Boolean = require( `@stdlib/boolean/ctor` );
1622+
*
16181623
* var bool = ns.isBoolean.isPrimitive( new Boolean( true ) );
16191624
* // returns false
16201625
*
16211626
* @example
1627+
* var Boolean = require( `@stdlib/boolean/ctor` );
1628+
*
16221629
* var bool = ns.isBoolean.isObject( new Boolean( false ) );
16231630
* // returns true
16241631
*/
@@ -1643,6 +1650,8 @@ interface Namespace {
16431650
* // returns true
16441651
*
16451652
* @example
1653+
* var Boolean = require( `@stdlib/boolean/ctor` );
1654+
*
16461655
* var bool = ns.isBooleanArray.objects( [ new Boolean( false ), new Boolean( true ) ] );
16471656
* // returns true
16481657
*/
@@ -2188,6 +2197,31 @@ interface Namespace {
21882197
*/
21892198
isCubeNumber: typeof isCubeNumber;
21902199

2200+
/**
2201+
* Tests if a value is either an integer equal to the current year or a `Date` object representing the current year.
2202+
*
2203+
* @param value - value to test
2204+
* @returns boolean indicating whether a provided value is the current year
2205+
*
2206+
* @example
2207+
* var bool = ns.isCurrentYear( new Date() );
2208+
* // returns true
2209+
*
2210+
* @example
2211+
* var currentYear = require( `@stdlib/time/current-year` );
2212+
* var bool = ns.isCurrentYear( currentYear() );
2213+
* // returns true
2214+
*
2215+
* @example
2216+
* var bool = ns.isCurrentYear( 2021 );
2217+
* // returns false
2218+
*
2219+
* @example
2220+
* var bool = ns.isCurrentYear( null );
2221+
* // returns false
2222+
*/
2223+
isCurrentYear: typeof isCurrentYear;
2224+
21912225
/**
21922226
* Boolean indicating if the current process is running on Darwin.
21932227
*
@@ -2301,6 +2335,8 @@ interface Namespace {
23012335
*/
23022336
isDateObject: typeof isDateObject;
23032337

2338+
isDateObjectArray: typeof isDateObjectArray;
2339+
23042340
/**
23052341
* Tests whether a string contains only numeric digits.
23062342
*
@@ -5428,6 +5464,30 @@ interface Namespace {
54285464
*/
54295465
isSameValueZero: typeof isSameValueZero;
54305466

5467+
/**
5468+
* Tests if a value is a semantic version string.
5469+
*
5470+
* @param value - value to test
5471+
* @returns boolean indicating whether a provided value is a semantic version string
5472+
*
5473+
* @example
5474+
* var bool = ns.isSemVer( '1.0.0' );
5475+
* // returns true
5476+
*
5477+
* @example
5478+
* var bool = ns.isSemVer( '1.0.0-alpha.1' );
5479+
* // returns true
5480+
*
5481+
* @example
5482+
* var bool = ns.isSemVer( '0.1' );
5483+
* // returns false
5484+
*
5485+
* @example
5486+
* var bool = ns.isSemVer( null );
5487+
* // returns false
5488+
*/
5489+
isSemVer: typeof isSemVer;
5490+
54315491
/**
54325492
* Tests if a value is a `SharedArrayBuffer`.
54335493
*

‎lib/node_modules/@stdlib/assert/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818

1919
/* tslint:disable:no-unused-expression */
2020

21-
import assert = require( './index' );
21+
import ns = require( './index' );
2222

2323

2424
// TESTS //
2525

2626
// The exported value is the expected interface...
2727
{
28-
assert; // $ExpectType Namespace
28+
ns; // $ExpectType Namespace
2929
}

‎lib/node_modules/@stdlib/assert/tools/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818

1919
/* tslint:disable:no-unused-expression */
2020

21-
import tools = require( './index' );
21+
import ns = require( './index' );
2222

2323

2424
// TESTS //
2525

2626
// The exported value is the expected interface...
2727
{
28-
tools; // $ExpectType Namespace
28+
ns; // $ExpectType Namespace
2929
}

‎lib/node_modules/@stdlib/bigint/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818

1919
/* tslint:disable:no-unused-expression */
2020

21-
import bigint = require( './index' );
21+
import ns = require( './index' );
2222

2323

2424
// TESTS //
2525

2626
// The exported value is the expected interface...
2727
{
28-
bigint; // $ExpectType Namespace
28+
ns; // $ExpectType Namespace
2929
}

‎lib/node_modules/@stdlib/blas/base/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818

1919
/* tslint:disable:no-unused-expression */
2020

21-
import base = require( './index' );
21+
import ns = require( './index' );
2222

2323

2424
// TESTS //
2525

2626
// The exported value is the expected interface...
2727
{
28-
base; // $ExpectType Namespace
28+
ns; // $ExpectType Namespace
2929
}

‎lib/node_modules/@stdlib/blas/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818

1919
/* tslint:disable:no-unused-expression */
2020

21-
import blas = require( './index' );
21+
import ns = require( './index' );
2222

2323

2424
// TESTS //
2525

2626
// The exported value is the expected interface...
2727
{
28-
blas; // $ExpectType Namespace
28+
ns; // $ExpectType Namespace
2929
}

‎lib/node_modules/@stdlib/blas/ext/base/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818

1919
/* tslint:disable:no-unused-expression */
2020

21-
import base = require( './index' );
21+
import ns = require( './index' );
2222

2323

2424
// TESTS //
2525

2626
// The exported value is the expected interface...
2727
{
28-
base; // $ExpectType Namespace
28+
ns; // $ExpectType Namespace
2929
}

‎lib/node_modules/@stdlib/blas/ext/docs/types/test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818

1919
/* tslint:disable:no-unused-expression */
2020

21-
import ext = require( './index' );
21+
import ns = require( './index' );
2222

2323

2424
// TESTS //
2525

2626
// The exported value is the expected interface...
2727
{
28-
ext; // $ExpectType Namespace
28+
ns; // $ExpectType Namespace
2929
}

0 commit comments

Comments
 (0)