-
-
Notifications
You must be signed in to change notification settings - Fork 399
/
index.d.ts
133 lines (119 loc) · 3.21 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
/*
* @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';
/**
* Interface defining function options.
*/
interface Options {
/**
* Encoding; ignored if the data argument is a buffer (default: null).
*/
encoding?: string | null;
/**
* Flag (default: 'r').
*/
flag?: string;
/**
* Mode (default: 0o666)
*/
mode?: number;
}
/**
* Callback invoked upon writing data to a file.
*
* @param err - error object
*/
type Callback = ( err: Error | null ) => void;
/**
* Interface for writing a file.
*/
interface WriteFile {
/**
* Asynchronously writes data to a file.
*
* @param file - file path or file descriptor
* @param data - data to write
* @param options - options; if a string, the value is the encoding
* @param clbk - callback to invoke after writing data to a file
*
* @example
* function onWrite( error ) {
* if ( error ) {
* throw error;
* }
* }
*
* var opts = { 'flag': 'r' };
* writeFile( './beep/boop.txt', 'beep boop\n', opts, onWrite );
*/
( file: string | Buffer | number, data: string | Buffer, options: Options | string, clbk: Callback ): void; // tslint-disable-line max-line-length
/**
* Asynchronously writes data to a file.
*
* @param file - file path or file descriptor
* @param data - data to write
* @param clbk - callback to invoke after writing data to a file
*
* @example
* function onWrite( error ) {
* if ( error ) {
* throw error;
* }
* }
*
* writeFile( './beep/boop.txt', 'beep boop\n', onWrite );
*/
( file: string | Buffer | number, data: string | Buffer, clbk: Callback ): void; // tslint-disable-line max-line-length
/**
* Synchronously writes data to a file.
*
* @param file - file path or file descriptor
* @param data - data to write
* @param options - options; if a string, the value is the encoding
* @returns error object or null
*
* @example
* var err = writeFileSync( './beep/boop.txt', 'beep boop\n' );
* if ( err instanceof Error ) {
* throw err;
* }
*/
sync( file: string | Buffer | number, data: string | Buffer, options?: Options | string ): Error | null; // tslint-disable-line max-line-length
}
/**
* Asynchronously writes data to a file.
*
* @param file - file path or file descriptor
* @param data - data to write
* @param options - options; if a string, the value is the encoding
* @param clbk - callback to invoke after writing data to a file
*
* @example
* function onWrite( error ) {
* if ( error ) {
* throw error;
* }
* }
*
* writeFile( './beep/boop.txt', 'beep boop\n', onWrite );
*/
declare var writeFile: WriteFile;
// EXPORTS //
export = writeFile;