Interface FilePredicate

A composable test applied to each file found during a search

interface FilePredicate {
    and(predicate: FilePredicate): FilePredicate;
    not(): FilePredicate;
    or(predicate: FilePredicate): FilePredicate;
    test(file: FileView): Promise<boolean>;
    testSync(file: FileView): boolean;
}

Index

Methods

and not or test testSync

Methods

and

and(predicate: FilePredicate): FilePredicate
Combines this predicate with another using logical AND
Parameters
- predicate: FilePredicate
  the predicate to combine with
Returns FilePredicate
a predicate that matches when both predicates match
- Defined in matchers.ts:30

not

not(): FilePredicate
Negates this predicate

Returns FilePredicate
a predicate that matches when this one does not
- Defined in matchers.ts:14

or

or(predicate: FilePredicate): FilePredicate
Combines this predicate with another using logical OR
Parameters
- predicate: FilePredicate
  the predicate to combine with
Returns FilePredicate
a predicate that matches when either predicate matches
- Defined in matchers.ts:22

test

test(file: FileView): Promise<boolean>
Asynchronously tests whether a file satisfies this predicate. Used by FileHound.find.
Parameters
- file: FileView
  the file to test
Returns Promise<boolean>
a Promise that fulfils with true if the file matches
- Defined in matchers.ts:39

testSync

testSync(file: FileView): boolean
Synchronously tests whether a file satisfies this predicate. Used by FileHound.findSync.
Parameters
- file: FileView
  the file to test
Returns boolean
true if the file matches

Throws
TypeError Thrown if the predicate can only be tested asynchronously.
- Defined in matchers.ts:50