Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/atom/node-oniguruma
Oniguruma Node Module
https://github.com/atom/node-oniguruma
Last synced: about 2 months ago
JSON representation
Oniguruma Node Module
- Host: GitHub
- URL: https://github.com/atom/node-oniguruma
- Owner: atom
- License: mit
- Archived: true
- Created: 2013-03-05T23:15:01.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-10-11T23:01:45.000Z (almost 2 years ago)
- Last Synced: 2024-07-23T13:04:43.448Z (about 2 months ago)
- Language: JavaScript
- Homepage: http://atom.github.io/node-oniguruma
- Size: 1.24 MB
- Stars: 120
- Watchers: 14
- Forks: 44
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
##### Atom and all repositories under Atom will be archived on December 15, 2022. Learn more in our [official announcement](https://github.blog/2022-06-08-sunsetting-atom/)
#### Atom and all repositories under Atom will be archived on December 15, 2022. Learn more in our [official announcement](https://github.blog/2022-06-08-sunsetting-atom/)
# Oniguruma Node module
[](https://travis-ci.org/atom/node-oniguruma)
[](https://ci.appveyor.com/project/Atom/node-oniguruma/branch/master)
[](https://david-dm.org/atom/node-oniguruma)
Native Node bindings to the Oniguruma regular expressions library.
Read all about Oniguruma regular expressions [here](https://github.com/kkos/oniguruma/blob/master/doc/RE).
Version 2.0 of this library added an asynchronous API, the old synchronous
methods have been renamed to have a `Sync` suffix.
## Installing
```sh
npm install oniguruma
```
## Building
* Clone the repository
* Run `npm install`
* Run `npm test` to run the specs
## Using
```coffeescript
{OnigRegExp, OnigScanner} = require 'oniguruma'
```
### OnigScanner(patterns)
Create a new scanner with the given patterns.
`patterns` - An array of string patterns.
### OnigScanner::findNextMatch(string, startPosition, callback)
Find the next match from a given position.
`string` - The string to search.
`startPosition` - The optional position to start at, defaults to `0`.
`callback` - The `(error, match)` function to call when done, `match` will
null when there is no match.
#### Example
```coffeescript
scanner = new OnigScanner(['c', 'a(b)?'])
scanner.findNextMatch 'abc', (error, match) ->
console.log match
{
index: 1, # Index of the best pattern match
captureIndices: [
{index: 0, start: 0, end: 2, length: 2}, # Entire match
{index: 1, start: 1, end: 2, length: 1} # Match of first capture group
]
}
```
### OnigScanner::findNextMatchSync(string, startPosition)
Synchronously find the next match from a given position.
`string` - The string to search.
`startPosition` - The optional position to start at, defaults to `0`.
Returns an object containing details about the match or `null` if no match.
#### Example
```coffeescript
scanner = new OnigScanner(['c', 'a(b)?'])
match = scanner.findNextMatchSync('abc')
console.log match
{
index: 1, # Index of the best pattern match
captureIndices: [
{index: 0, start: 0, end: 2, length: 2}, # Entire match
{index: 1, start: 1, end: 2, length: 1} # Match of first capture group
]
}
```
### OnigRegExp(pattern)
Create a new regex with the given pattern.
`pattern` - A string pattern.
### OnigRegExp::search(string, startPosition, callback)
Search the string for a match starting at the given position.
`string` - The string to search.
`startPosition` - The optional position to start the search at, defaults to `0`.
`callback` - The `(error, match)` function to call when done, `match` will be
null if no matches were found. `match` will be an array of objects for each
matched group on a successful search.
#### Example
```coffeescript
regex = new OnigRegExp('a([b-d])c')
regex.search '!abcdef', (error, match) ->
console.log match
[
{index: 0, start: 1, end: 4, match: 'abc', length: 3}, # Entire match
{index: 1, start: 2, end: 3, match: 'b', length: 1} # Match of first capture group
]
```
### OnigRegExp::searchSync(string, startPosition)
Synchronously search the string for a match starting at the given position.
`string` - The string to search.
`startPosition` - The optional position to start the search at, defaults to `0`.
Returns an array of objects for each matched group or `null` if no match was
found.
#### Example
```coffeescript
regex = new OnigRegExp('a([b-d])c')
match = regex.searchSync('!abcdef')
console.log match
[
{index: 0, start: 1, end: 4, match: 'abc', length: 3}, # Entire match
{index: 1, start: 2, end: 3, match: 'b', length: 1} # Match of first capture group
]
```
### OnigRegExp::test(string, callback)
Test if this regular expression matches the given string.
`string` - The string to test against.
`callback` - The `(error, matches)` function to call when done, `matches` will
be `true` if at least one match is found, `false` otherwise.
#### Example
```coffeescript
regex = new OnigRegExp('a([b-d])c')
regex.test 'abcdef', (error, matches) ->
console.log matches # true
```
### OnigRegExp::testSync(string)
Synchronously test if this regular expression matches the given string.
`string` - The string to test against.
Returns `true` if at least one match, `false` otherwise.
#### Example
```coffeescript
regex = new OnigRegExp('a([b-d])c')
matches = regex.testSync('abcdef')
console.log matches # true
```