Add Typescript definition

Planeshifter · Planeshifter · commit c7669d7b7832 · 2021-04-16T10:42:06.000-04:00
diff --git a/lib/node_modules/@stdlib/buffer/ctor/docs/types/index.d.ts b/lib/node_modules/@stdlib/buffer/ctor/docs/types/index.d.ts
@@ -0,0 +1,37 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 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
+
+/// <reference types="node"/>
+
+import { Buffer } from 'buffer';
+
+
+// EXPORTS //
+
+/**
+* Buffer constructor.
+*
+* @example
+* var ctor = require( `@stdlib/buffer/ctor` );
+*
+* var b = new ctor( [ 1, 2, 3, 4 ] );
+* // returns <Buffer>
+*/
+export = Buffer;
diff --git a/lib/node_modules/@stdlib/buffer/ctor/docs/types/test.ts b/lib/node_modules/@stdlib/buffer/ctor/docs/types/test.ts
@@ -0,0 +1,37 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 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.
+*/
+
+// tslint:disable:no-construct
+// tslint:disable:no-unused-expression
+// tslint:disable:deprecation
+
+import Buffer = require( './index' );
+
+
+// TESTS //
+
+// The function returns a buffer instance...
+{
+	new Buffer( 10 ); // $ExpectType Buffer
+	new Buffer( [ 1, 2, 3, 4 ] ); // $ExpectType Buffer
+}
+
+// The function does not compile if provided an unsupported number of arguments...
+{
+	new Buffer(); // $ExpectError
+}
diff --git a/lib/node_modules/@stdlib/buffer/ctor/package.json b/lib/node_modules/@stdlib/buffer/ctor/package.json
@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {
