UnixBuilderImpl
Defined in: packages/core/src/builder.ts:247
Immutable builder. Every method returns a new instance — the original is never modified.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UnixBuilderImpl(
init?):UnixBuilderImpl
Defined in: packages/core/src/builder.ts:256
Parameters
Section titled “Parameters”BuilderInit
Returns
Section titled “Returns”UnixBuilderImpl
Methods
Section titled “Methods”bin(
name,fn):UnixBuilder
Defined in: packages/core/src/builder.ts:287
Sugar for .use({ bins: { [name]: fn } }).
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”boot()
Section titled “boot()”boot(
runtime,opts?):Promise<UnixInstance>
Defined in: packages/core/src/builder.ts:355
Boot an instance from the built image. Requires a runtime (e.g. testRuntime(), nodeRuntime()).
Parameters
Section titled “Parameters”runtime
Section titled “runtime”Returns
Section titled “Returns”Promise<UnixInstance>
Implementation of
Section titled “Implementation of”build()
Section titled “build()”build():
Promise<UnixImage>
Defined in: packages/core/src/builder.ts:311
Returns
Section titled “Returns”Promise<UnixImage>
Implementation of
Section titled “Implementation of”catalog()
Section titled “catalog()”catalog(
name,factory):UnixBuilder
Defined in: packages/core/src/builder.ts:307
Parameters
Section titled “Parameters”string
factory
Section titled “factory”() => Extension
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”env(
key,value):UnixBuilder
Defined in: packages/core/src/builder.ts:291
Sugar for .use({ env: { [key]: value } }).
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”file()
Section titled “file()”file(
path,content):UnixBuilder
Defined in: packages/core/src/builder.ts:295
Sugar for .use({ files: { [path]: content } }).
Parameters
Section titled “Parameters”string
content
Section titled “content”string
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”mount()
Section titled “mount()”mount(
path,server):UnixBuilder
Defined in: packages/core/src/builder.ts:283
Sugar for .use({ mounts: { [path]: server } }).
Parameters
Section titled “Parameters”string
server
Section titled “server”Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”run(
command):UnixBuilder
Defined in: packages/core/src/builder.ts:303
Record a shell command to execute at build time. Executed sequentially by .build().
Parameters
Section titled “Parameters”command
Section titled “command”string
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”service()
Section titled “service()”service(
def):UnixBuilder
Defined in: packages/core/src/builder.ts:299
Sugar for .use({ services: [def] }).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”use(
ext):UnixBuilder
Defined in: packages/core/src/builder.ts:279
Compose an Extension into the builder. Returns a new builder.