Add Typescript definition

Author: Planeshifter

lib/node_modules/@stdlib/fs/read-dir/docs/types/index.d.ts

@@ -0,0 +1,119 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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';
+
+/**
+* Callback invoked after reading the contents of a directory.
+*/
+type Nullary = () => void;
+
+/**
+* Callback invoked after reading the contents of a directory.
+*
+* @param err - error argument
+*/
+type Unary = ( err: Error ) => void;
+
+/**
+* Callback invoked after reading the contents of a directory.
+*
+* @param err - error argument
+* @param data - directory contents
+*/
+type Binary = ( err: Error, data: Array<string> ) => void;
+
+/**
+* Callback invoked after reading the contents of a directory.
+*
+* @param err - error argument
+* @param data - directory contents
+*/
+type Callback = Nullary | Unary | Binary;
+
+/**
+* Interface for reading the contents of a directory.
+*/
+interface ReadDir {
+	/**
+	* Asynchronously reads the contents of a directory.
+	*
+	* @param path - directory path
+	* @param clbk - callback to invoke after reading directory contents
+	*
+	* @example
+	* function onRead( error, data ) {
+	*     if ( error ) {
+	*         console.error( error );
+	*     } else {
+	*         console.log( data );
+	*     }
+	* }
+	* readDir( __dirname, onRead );
+	*/
+	( path: string | Buffer, clbk: Callback ): void;
+
+	/**
+	* Synchronously reads the contents of a directory.
+	*
+	* @param path - directory path
+	* @returns directory contents or an error
+	*
+	* @example
+	* var out = readDir.sync( __dirname );
+	* if ( out instanceof Error ) {
+	*     throw out;
+	* }
+	* console.log( out );
+	*/
+	sync( path: string | Buffer ): Array<string> | Error;
+}
+
+/**
+* Asynchronously reads the contents of a directory.
+*
+* @param path - directory path
+* @param clbk - callback to invoke after reading directory contents
+*
+* @example
+* function onRead( error, data ) {
+*     if ( error ) {
+*         console.error( error );
+*     } else {
+*         console.log( data );
+*     }
+* }
+* readDir( __dirname, onRead );
+*
+* @example
+* var out = readDir.sync( __dirname );
+* if ( out instanceof Error ) {
+*     throw out;
+* }
+* console.log( out );
+*/
+declare var readDir: ReadDir;
+
+
+// EXPORTS //
+
+export = readDir;

lib/node_modules/@stdlib/fs/read-dir/docs/types/test.ts

@@ -0,0 +1,85 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2020 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.
+*/
+
+import readDir = require( './index' );
+
+const done = ( error: Error, data: Array<string> ) => {
+	if ( error || !data.length ) {
+		throw error;
+	}
+};
+
+
+// TESTS //
+
+// The function does not have a return value...
+{
+	readDir( 'beepboop', done ); // $ExpectType void
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a string...
+{
+	readDir( 123, done ); // $ExpectError
+	readDir( false, done ); // $ExpectError
+	readDir( true, done ); // $ExpectError
+	readDir( null, done ); // $ExpectError
+	readDir( undefined, done ); // $ExpectError
+	readDir( [], done ); // $ExpectError
+	readDir( {}, done ); // $ExpectError
+	readDir( ( x: number ): number => x, done ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not a function with the expected signature...
+{
+	readDir( '/var/log/', 1 ); // $ExpectError
+	readDir( '/var/log/', false ); // $ExpectError
+	readDir( '/var/log/', true ); // $ExpectError
+	readDir( '/var/log/', null ); // $ExpectError
+	readDir( '/var/log/', undefined ); // $ExpectError
+	readDir( '/var/log/', [] ); // $ExpectError
+	readDir( '/var/log/', {} ); // $ExpectError
+	readDir( '/var/log/', ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	readDir(); // $ExpectError
+	readDir( 'C:\\foo\\bar\\baz' ); // $ExpectError
+}
+
+// Attached to main export is a `sync` method which returns a string array...
+{
+	readDir.sync( 'beepboop' ); // $ExpectType Error | string[]
+}
+
+// The compiler throws an error if the `sync` method is provided a first argument which is not a string...
+{
+	readDir.sync( 123 ); // $ExpectError
+	readDir.sync( false ); // $ExpectError
+	readDir.sync( true ); // $ExpectError
+	readDir.sync( null ); // $ExpectError
+	readDir.sync( undefined ); // $ExpectError
+	readDir.sync( [] ); // $ExpectError
+	readDir.sync( {} ); // $ExpectError
+	readDir.sync( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the `sync` method is provided an unsupported number of arguments...
+{
+	readDir.sync(); // $ExpectError
+}