new FileSniffer()
- Source:
Methods
(static) collect()
Sets the collector
Parameters:
| Type | Description |
|---|---|
| Collector | logic to collect matching lines |
- Source:
Returns:
a FileSniffer instance
Example
import FileSniffer from 'FileSniffer';
const matches = await FileSniffer.create()
.collect(asObject())
.find('str');(static) create()
Static factory method to create an instance of FileSniffer
- Source:
Returns:
FileSniffer instance
Example
import FileSniffer from 'filesniffer';
const FileSniffer = FileSniffer.create();(static) find()
Set the search paths for FileSniffer - can be a mixture of file and directories
Parameters:
| Type | Description |
|---|---|
| string | pattern | search criteria |
- Source:
Returns:
a promise of matches
Example
import FileSniffer from 'FileSniffer';
const matches = await FileSniffer.create()
.collect(asArray())
.find('str');(static) gzip(none)
Enables FileSniffer to search gzipped files
Parameters:
| Name | Type | Description |
|---|---|---|
none |
- Source:
Returns:
a FileSniffer instance
Example
import FileSniffer from 'FileSniffer';
const sniffer = FileSniffer.create()
.gzip()
.collect(asArray())
.find('str');(static) path(path)
Set the search path for FileSniffer - file or directory
Parameters:
| Name | Type | Description |
|---|---|---|
path |
string | search path |
- Source:
Returns:
a FileSniffer instance
Example
import FileSniffer from 'FileSniffer';
const sniffer = FileSniffer.create()
.path(someFile)
.collect(asArray())
.find('str');(static) path(path)
Enables FileSniffer to search recursively
Parameters:
| Name | Type | Description |
|---|---|---|
path |
string | path of file (or directory) to search |
- Source:
Returns:
a FileSniffer instance
Example
import FileSniffer from 'FileSniffer';
const sniffer = FileSniffer.create()
.path(someFile)
.collect(asArray())
.find('str');(static) paths(paths)
Set the search paths for FileSniffer - can be a mixture of file and directories
Parameters:
| Name | Type | Description |
|---|---|---|
paths |
string | search paths |
- Source:
Returns:
a FileSniffer instance
Example
import FileSniffer from 'FileSniffer';
const sniffer = FileSniffer.create()
.paths(arrayOfPaths)
.collect(asArray())
.find('str');