Props
Defined in: src/Props.ts:26
Immutable configuration describing how to create an actor.
Use Props.create(() => new MyActor(...)) and chain with… for
additional configuration.
Type Parameters
Section titled “Type Parameters”TMsg = unknown
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Props<
TMsg>(config):Props<TMsg>
Defined in: src/Props.ts:27
Parameters
Section titled “Parameters”config
Section titled “config”PropsConfig<TMsg>
Returns
Section titled “Returns”Props<TMsg>
Properties
Section titled “Properties”config
Section titled “config”
readonlyconfig:PropsConfig<TMsg>
Defined in: src/Props.ts:27
Methods
Section titled “Methods”withDispatcher()
Section titled “withDispatcher()”withDispatcher(
dispatcher):Props<TMsg>
Defined in: src/Props.ts:37
Parameters
Section titled “Parameters”dispatcher
Section titled “dispatcher”Returns
Section titled “Returns”Props<TMsg>
withMailbox()
Section titled “withMailbox()”withMailbox(
factory):Props<TMsg>
Defined in: src/Props.ts:45
Parameters
Section titled “Parameters”factory
Section titled “factory”MailboxFactory<TMsg>
Returns
Section titled “Returns”Props<TMsg>
withMailboxCapacity()
Section titled “withMailboxCapacity()”withMailboxCapacity(
capacity):Props<TMsg>
Defined in: src/Props.ts:41
Parameters
Section titled “Parameters”capacity
Section titled “capacity”number
Returns
Section titled “Returns”Props<TMsg>
withSupervisorStrategy()
Section titled “withSupervisorStrategy()”withSupervisorStrategy(
strategy):Props<TMsg>
Defined in: src/Props.ts:33
Parameters
Section titled “Parameters”strategy
Section titled “strategy”Returns
Section titled “Returns”Props<TMsg>
create()
Section titled “create()”
staticcreate<TMsg>(factory):Props<TMsg>
Defined in: src/Props.ts:29
Type Parameters
Section titled “Type Parameters”TMsg
Parameters
Section titled “Parameters”factory
Section titled “factory”ActorFactory<TMsg>
Returns
Section titled “Returns”Props<TMsg>