Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "fs/resolve-parent-path-by/docs/types/index.d"

Index

Interfaces

Type aliases

Variables

Type aliases

AsyncPredicate

AsyncPredicate: (path: string, next: NextCallback) => void

Checks whether a resolved path passes a test.

param

resolved path

param

callback which should be called once the predicate function has finished processing a resolved path

Type declaration

Binary

Binary: (error: Error | null, result: boolean) => void

Callback function.

param

encountered error or null

param

test result

Type declaration

    • (error: Error | null, result: boolean): void

    • Parameters

      • error: Error | null
      • result: boolean

      Returns void

DoneCallback

DoneCallback: (error: Error | null, path: string | null) => void

Callback invoked after resolving a path according to a predicate function.

param

error object

param

resolved path

Type declaration

    • (error: Error | null, path: string | null): void

    • Parameters

      • error: Error | null
      • path: string | null

      Returns void

NextCallback

NextCallback: Nullary | Unary | Binary

Callback function.

param

encountered error or null

param

test result

Nullary

Nullary: () => void

Callback function.

Type declaration

    • (): void

    • Returns void

SyncPredicate

SyncPredicate: (path: string) => boolean

Checks whether a resolved path passes a test.

param

resolved path

returns

test result

Type declaration

    • (path: string): boolean

    • Parameters

      • path: string

      Returns boolean

Unary

Unary: (error: Error | null) => void

Callback function.

param

encountered error or null

Type declaration

    • (error: Error | null): void

    • Parameters

      • error: Error | null

      Returns void

Variables

Export assignment resolveParentPathBy

resolveParentPathBy: ResolveParentPathBy

Asynchronously resolves a path according to a predicate function by walking parent directories.

param

path to resolve

param

function options

param

base directory

param

predicate function

param

callback to invoke after resolving a path

throws

must provide valid options