-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
71 lines (60 loc) · 1.62 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
/*
* @license Apache-2.0
*
* Copyright (c) 2022 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
/**
* Format identifier object.
*/
interface FormatIdentifier {
/**
* Format specifier (one of 's', 'c', 'd', 'i', 'u', 'b', 'o', 'x', 'X', 'e', 'E', 'f', 'F', 'g', 'G').
*/
specifier: string;
/**
* Flags.
*/
flags?: string;
/**
* Minimum field width (integer or `'*'`).
*/
width?: string;
/**
* Precision (integer or `'*'`).
*/
precision?: string;
/**
* Positional mapping from format specifier to argument index.
*/
mapping?: number;
}
type StringOrToken = string | FormatIdentifier;
/**
* Generates string from a token array by interpolating values.
*
* @param tokens - string parts and format identifier objects
* @param ...args - variable values
* @throws invalid flags
* @returns formatted string
*
* @example
* var tokens = [ 'beep ', { 'specifier': 's' } ];
* var out = formatInterpolate( tokens, 'boop' );
* // returns 'beep boop'
*/
declare function formatInterpolate( tokens: Array<StringOrToken>, ...args: Array<any> ): string;
// EXPORTS //
export = formatInterpolate;