-
-
Notifications
You must be signed in to change notification settings - Fork 79
Add TypeScript definition #32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
b30a629
added TS typings
Akim95 999b653
improved style
Akim95 8a312d5
added Typescript tests
Akim95 098a19d
update test
Akim95 d661e56
update ts interface doc
Akim95 eb3032f
update ts interface doc again
Akim95 fe87e5f
wrap with namespace
Akim95 b0ebcfa
fix tab
Akim95 0ef411d
Update index.d.ts
sindresorhus 8cf04d9
Update index.test-d.ts
sindresorhus File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
declare namespace ansiRegex { | ||
interface Options { | ||
/** | ||
Match only the first ANSI escape. | ||
@default false | ||
*/ | ||
onlyFirst: boolean; | ||
} | ||
} | ||
|
||
/** | ||
Regular expression for matching ANSI escape codes. | ||
@example | ||
``` | ||
import ansiRegex = require('ansi-regex'); | ||
ansiRegex().test('\u001B[4mcake\u001B[0m'); | ||
//=> true | ||
ansiRegex().test('cake'); | ||
//=> false | ||
'\u001B[4mcake\u001B[0m'.match(ansiRegex()); | ||
//=> ['\u001B[4m', '\u001B[0m'] | ||
'\u001B[4mcake\u001B[0m'.match(ansiRegex({onlyFirst: true})); | ||
//=> ['\u001B[4m'] | ||
'\u001B]8;;https://github.com\u0007click\u001B]8;;\u0007'.match(ansiRegex()); | ||
//=> ['\u001B]8;;https://github.com\u0007', '\u001B]8;;\u0007'] | ||
``` | ||
*/ | ||
declare function ansiRegex(options?: ansiRegex.Options): RegExp; | ||
|
||
export = ansiRegex; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
import {expectType} from 'tsd'; | ||
import ansiRegex from '.'; | ||
|
||
expectType<RegExp>(ansiRegex()); | ||
expectType<RegExp>(ansiRegex({onlyFirst: true})); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.