Skip to content

Commit c7669d7

Browse files
committed
Add Typescript definition
1 parent ca732f5 commit c7669d7

File tree

3 files changed

+75
-0
lines changed

3 files changed

+75
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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+
/// <reference types="node"/>
22+
23+
import { Buffer } from 'buffer';
24+
25+
26+
// EXPORTS //
27+
28+
/**
29+
* Buffer constructor.
30+
*
31+
* @example
32+
* var ctor = require( `@stdlib/buffer/ctor` );
33+
*
34+
* var b = new ctor( [ 1, 2, 3, 4 ] );
35+
* // returns <Buffer>
36+
*/
37+
export = Buffer;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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-construct
20+
// tslint:disable:no-unused-expression
21+
// tslint:disable:deprecation
22+
23+
import Buffer = require( './index' );
24+
25+
26+
// TESTS //
27+
28+
// The function returns a buffer instance...
29+
{
30+
new Buffer( 10 ); // $ExpectType Buffer
31+
new Buffer( [ 1, 2, 3, 4 ] ); // $ExpectType Buffer
32+
}
33+
34+
// The function does not compile if provided an unsupported number of arguments...
35+
{
36+
new Buffer(); // $ExpectError
37+
}

lib/node_modules/@stdlib/buffer/ctor/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
"lib": "./lib",
2222
"test": "./test"
2323
},
24+
"types": "./docs/types",
2425
"scripts": {},
2526
"homepage": "https://github.com/stdlib-js/stdlib",
2627
"repository": {

0 commit comments

Comments
 (0)