-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
67 lines (58 loc) · 1.7 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
/*
* @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
/* tslint:disable:max-line-length */
/* tslint:disable:max-file-line-count */
import formatInterpolate = require( '@stdlib/string/base/format-interpolate' );
import formatTokenize = require( '@stdlib/string/base/format-tokenize' );
/**
* Interface describing the `base` namespace.
*/
interface Namespace {
/**
* 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'
*/
formatInterpolate: typeof formatInterpolate;
/**
* Tokenizes a string into an array of string parts and format identifier objects.
*
* @param str - input string
* @returns tokens
*
* @example
* var tokens = formatTokenize( 'Hello %s!' );
* // returns [ 'Hello ', {...}, '!' ]
*/
formatTokenize: typeof formatTokenize;
}
/**
* String base packages.
*/
declare var ns: Namespace;
// EXPORTS //
export = ns;