The core component of Barnard59 Linked Data pipelines to create and run pipelines.
The package exports multiple functions which can be imported like this:
import { createPipeline, run } from 'barnard59-core'
Creates a new Pipeline
object based on the definition given as graph pointer in ptr
.
The function accepts the following arguments:
-
ptr
: A graph pointer to the pipeline definition. -
basePath
: Optional an alternative base path given as string, which is used by the code loaders. -
context
: Additional optional properties which will be merged into the loader context. -
logger
: An optional alternativewinston
logger instance that should be used. SeedefaultLogger()
if you want to create a logger based on the default logger settings. -
variables
: Additional optional variables which will be merged into the pipeline variables.
Creates an instance of a loader registry that contains all default loaders. The function can be used to create custom registry instances based on the defaults.
The function accepts the following arguments:
-
console
(default:true
) -
errorFilename
(default:null
) -
filename
: (default:null
) -
level
: (default:error
)
Wait for a pipeline to finish.
Optional calls .end()
or .resume()
on the stream of the pipeline to trigger processing.
The function accepts the following arguments:
-
pipeline
: The pipeline as Pipeline object. -
end
: An optional flag, iftrue
calls.end()
on the stream of the pipeline. (default =false
) -
resume
: An optional flag, iftrue
calls.resume()
on the stream of the pipeline. (default =false
)