File: index.d.ts

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (96 lines) | stat: -rw-r--r-- 2,408 bytes parent folder | download
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
/*
* @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

type PLATFORM = 'win32' | 'posix';

/**
* Interface for a regular expression to capture the last part of a path.
*/
interface ReBasename {
	/**
	* Returns a regular expression to capture the last part of a path.
	*
	* @param platform - path platform (`win32` or `posix`)
	* @returns regular expression
	*
	* @example
	* // Returns a platform-dependent regular expression when no `platform` is supplied:
	* var RE = reBasename();
	* // returns <RegExp>
	*
	* var bool = ( RE === reBasename( 'win32' ) ) || ( RE === reBasename( 'posix' ) );
	* // returns true
	*/
	( platform?: PLATFORM ): RegExp;

	/**
	* Regular expression to capture the last part of a path.
	*
	* @example
	* var RE = reBasename.REGEXP;
	* // returns <RegExp>
	*/
	REGEXP: RegExp;

	/**
	* Regular expression to capture the last part of a Windows path.
	*
	* @example
	* var base = reBasename.REGEXP_WIN32.exec( 'C:\\foo\\bar\\index.js' )[ 1 ];
	* // returns 'index.js'
	*/
	REGEXP_WIN32: RegExp;

	/**
	* Regular expression to capture the last part of a POSIX path.
	*
	* @example
	* var base = reBasename.REGEXP_POSIX.exec( 'foo/bar/index.js' )[ 1 ]
	* // returns 'index.js'
	*/
	REGEXP_POSIX: RegExp;
}

/**
* Returns a regular expression to capture the last part of a path.
*
* @param platform - path platform (`win32` or `posix`)
* @returns regular expression
*
* @example
* var RE_BASENAME = reBasename();
* // returns <RegExp>
*
* @example
* var RE_BASENAME = reBasename( 'posix' );
* var base = RE_BASENAME.exec( '/foo/bar/index.js' )[ 1 ];
* // returns 'index.js'
*
* @example
* var RE_BASENAME = reBasename( 'win32' );
* var base = RE_BASENAME.exec( 'C:\\foo\\bar\\index.js' )[ 1 ];
* // returns 'index.js'
*/
declare var reBasename: ReBasename;


// EXPORTS //

export = reBasename;