-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
166 lines (151 loc) · 3.56 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/*
* @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';
/**
* Interface defining function options.
*/
interface Options {
/**
* Encoding (default: null).
*/
encoding?: string | null;
/**
* Flag (default: 'r').
*/
flag?: string;
}
/**
* Interface defining a file.
*/
interface File {
/**
* File path.
*/
file: string;
/**
* File contents.
*/
data: Buffer | string;
}
/**
* Callback invoked upon reading files.
*
* @param err - error object
* @param files - file objects
*/
type Callback = ( err: Error | null, files: Array<File> ) => void;
/**
* Interface for reading the entire contents of each file in a file list.
*/
interface ReadFileList {
/**
* Asynchronously reads the entire contents of each file in a file list.
*
* @param list - list of file paths
* @param options - options
* @param options.encoding - file encoding
* @param options.flag - file status flag
* @param clbk - callback to invoke after reading file contents
*
* @example
* var list = [ __filename ];
*
* readFileList( list, onFiles );
*
* function onFiles( error, files ) {
* if ( error ) {
* throw error;
* }
* console.dir( files );
* }
*/
( list: Array<string>, options: Options | string, clbk: Callback ): void;
/**
* Asynchronously reads the entire contents of each file in a file list.
*
* @param list - list of file paths
* @param clbk - callback to invoke after reading file contents
*
* @example
* var list = [ __filename ];
*
* readFileList( list, onFiles );
*
* function onFiles( error, files ) {
* if ( error ) {
* throw error;
* }
* console.dir( files );
* }
*/
( list: Array<string>, clbk: Callback ): void;
/**
* Synchronously reads the entire contents of each file in a file list.
*
* @param list - list of file paths
* @param options - options
* @param options.encoding - file encoding
* @param options.flag - file status flag
* @returns file contents
*
* @example
* var list = [ __filename ];
* var files = readFileList.sync( list );
*
* if ( files instanceof Error ) {
* throw files;
* }
* console.dir( files );
*/
sync( list: Array<string>, options?: Options | string ): Array<File> | Error; // tslint-disable-line max-line-length
}
/**
* Asynchronously reads the entire contents of each file in a file list.
*
* @param list - list of file paths
* @param options - options
* @param options.encoding - file encoding
* @param options.flag - file status flag
* @param clbk - callback to invoke after reading file contents
*
* @example
* var list = [ __filename ];
*
* readFileList( list, onFiles );
*
* function onFiles( error, files ) {
* if ( error ) {
* throw error;
* }
* console.dir( files );
* }
*
* @example
* var list = [ __filename ];
* var files = readFileList.sync( list );
*
* if ( files instanceof Error ) {
* throw files;
* }
* console.dir( files );
*/
declare var readFileList: ReadFileList;
// EXPORTS //
export = readFileList;