stagas / alice-bob

transport agnostic strongly typed duplex rpc interfaces

alice-bob

transport agnostic strongly typed duplex rpc interfaces

npm i alice-bob

pnpm add alice-bob

yarn add alice-bob

API

# Alice – Alice class.

src/alice-bob.ts#L292

# constructor(send, target) – Creates an instance of Alice.

src/alice-bob.ts#L297

# new Alice() – Creates an instance of Alice.

Alice<A, B>

# send

PayloadMethod<Agent<A, B>>

# target

A

# local – The local Agent.

src/alice-bob.ts#L95

{

# debug – Whether or not to log debugging information.

src/alice-bob.ts#L32

boolean

# name – The name of the agent. Defaults to either 'alice' or 'bob' depending on the constructor used, Alice or Bob.

src/alice-bob.ts#L38

string

# send – The send method overriden by the user to any transport.

src/alice-bob.ts#L43

PayloadMethod<Agent<B, A>>

# deferredSend() – Returns the send method. Used in contexts where it might change between sessions, like browser refresh/hot/livereload.

src/alice-bob.ts#L49

deferredSend()  =>

PayloadMethod<Agent<B, A>>

# deserializer(data)

src/alice-bob.ts#L57

# data

unknown

deserializer(data)  =>

any

# log(args) – Overridable logging function. Defaults to console.log() and prepends agent.name.

src/alice-bob.ts#L63

# args

unknown []

log(args)  =>

void

# serializer(data)

src/alice-bob.ts#L56

# data

unknown

serializer(data)  =>

any

} & A & {
# target

src/alice-bob.ts#L95

A

}

# remote – The remote Agent.

src/alice-bob.ts#L99

Agent<B, A>

# agents(local, remote) – Returns the agents tuple [alice, bob].

src/alice-bob.ts#L276

Example:

const [alice, bob] = new Alice<Local, Remote>().agents()

// to enable debugging on local (alice)
const [alice, bob] = new Alice<Local, Remote>().agents({ debug: true })

// use different names:
const [alice, bob] = new Alice<Local, Remote>().agents(
  { name: 'server', debug: true },
  { name: 'client' }
)

# local

null | Partial<Agent<A, B>>

# remote

null | Partial<Agent<B, A>>

agents(local, remote)  =>

[ {
# debug – Whether or not to log debugging information.

src/alice-bob.ts#L32

boolean

# name – The name of the agent. Defaults to either 'alice' or 'bob' depending on the constructor used, Alice or Bob.

src/alice-bob.ts#L38

string

# send – The send method overriden by the user to any transport.

src/alice-bob.ts#L43

PayloadMethod<Agent<B, A>>

# deferredSend() – Returns the send method. Used in contexts where it might change between sessions, like browser refresh/hot/livereload.

src/alice-bob.ts#L49

deferredSend()  =>

PayloadMethod<Agent<B, A>>

# deserializer(data)

src/alice-bob.ts#L57

# data

unknown

deserializer(data)  =>

any

# log(args) – Overridable logging function. Defaults to console.log() and prepends agent.name.

src/alice-bob.ts#L63

# args

unknown []

log(args)  =>

void

# serializer(data)

src/alice-bob.ts#L56

# data

unknown

serializer(data)  =>

any

} & A & {
# target

src/alice-bob.ts#L95

A

}, Agent<B, A> ]

# deserializer(data)

src/alice-bob.ts#L108

# data

any

deserializer(data)  =>

any

# serializer(data)

src/alice-bob.ts#L107

# data

any

serializer(data)  =>

any

# AliceBob – AliceBob class.

src/alice-bob.ts#L82

# constructor(send) – Creates an instance of AliceBob.

src/alice-bob.ts#L114

# new AliceBob() – Creates an instance of AliceBob.

AliceBob<A, B>

# send

PayloadMethod<Agent<A, B>>

# local – The local Agent.

src/alice-bob.ts#L95

{

# debug – Whether or not to log debugging information.

src/alice-bob.ts#L32

boolean

# name – The name of the agent. Defaults to either 'alice' or 'bob' depending on the constructor used, Alice or Bob.

src/alice-bob.ts#L38

string

# send – The send method overriden by the user to any transport.

src/alice-bob.ts#L43

PayloadMethod<Agent<B, A>>

# deferredSend() – Returns the send method. Used in contexts where it might change between sessions, like browser refresh/hot/livereload.

src/alice-bob.ts#L49

deferredSend()  =>

PayloadMethod<Agent<B, A>>

# deserializer(data)

src/alice-bob.ts#L57

# data

unknown

deserializer(data)  =>

any

# log(args) – Overridable logging function. Defaults to console.log() and prepends agent.name.

src/alice-bob.ts#L63

# args

unknown []

log(args)  =>

void

# serializer(data)

src/alice-bob.ts#L56

# data

unknown

serializer(data)  =>

any

} & A & {
# target

src/alice-bob.ts#L95

A

}

# remote – The remote Agent.

src/alice-bob.ts#L99

Agent<B, A>

# agents(local, remote) – Returns the agents tuple [alice, bob].

src/alice-bob.ts#L276

Example:

const [alice, bob] = new Alice<Local, Remote>().agents()

// to enable debugging on local (alice)
const [alice, bob] = new Alice<Local, Remote>().agents({ debug: true })

// use different names:
const [alice, bob] = new Alice<Local, Remote>().agents(
  { name: 'server', debug: true },
  { name: 'client' }
)

# local

null | Partial<Agent<A, B>>

# remote

null | Partial<Agent<B, A>>

agents(local, remote)  =>

[ {
# debug – Whether or not to log debugging information.

src/alice-bob.ts#L32

boolean

# name – The name of the agent. Defaults to either 'alice' or 'bob' depending on the constructor used, Alice or Bob.

src/alice-bob.ts#L38

string

# send – The send method overriden by the user to any transport.

src/alice-bob.ts#L43

PayloadMethod<Agent<B, A>>

# deferredSend() – Returns the send method. Used in contexts where it might change between sessions, like browser refresh/hot/livereload.

src/alice-bob.ts#L49

deferredSend()  =>

PayloadMethod<Agent<B, A>>

# deserializer(data)

src/alice-bob.ts#L57

# data

unknown

deserializer(data)  =>

any

# log(args) – Overridable logging function. Defaults to console.log() and prepends agent.name.

src/alice-bob.ts#L63

# args

unknown []

log(args)  =>

void

# serializer(data)

src/alice-bob.ts#L56

# data

unknown

serializer(data)  =>

any

} & A & {
# target

src/alice-bob.ts#L95

A

}, Agent<B, A> ]

# deserializer(data)

src/alice-bob.ts#L108

# data

any

deserializer(data)  =>

any

# serializer(data)

src/alice-bob.ts#L107

# data

any

serializer(data)  =>

any

# Bob – Bob class.

src/alice-bob.ts#L313

# constructor(send, target) – Creates an instance of Bob.

src/alice-bob.ts#L318

# new Bob() – Creates an instance of Bob.

Bob<A, B>

# send

PayloadMethod<Agent<A, B>>

# target

A

# local – The local Agent.

src/alice-bob.ts#L95

{

# debug – Whether or not to log debugging information.

src/alice-bob.ts#L32

boolean

# name – The name of the agent. Defaults to either 'alice' or 'bob' depending on the constructor used, Alice or Bob.

src/alice-bob.ts#L38

string

# send – The send method overriden by the user to any transport.

src/alice-bob.ts#L43

PayloadMethod<Agent<B, A>>

# deferredSend() – Returns the send method. Used in contexts where it might change between sessions, like browser refresh/hot/livereload.

src/alice-bob.ts#L49

deferredSend()  =>

PayloadMethod<Agent<B, A>>

# deserializer(data)

src/alice-bob.ts#L57

# data

unknown

deserializer(data)  =>

any

# log(args) – Overridable logging function. Defaults to console.log() and prepends agent.name.

src/alice-bob.ts#L63

# args

unknown []

log(args)  =>

void

# serializer(data)

src/alice-bob.ts#L56

# data

unknown

serializer(data)  =>

any

} & A & {
# target

src/alice-bob.ts#L95

A

}

# remote – The remote Agent.

src/alice-bob.ts#L99

Agent<B, A>

# agents(local, remote) – Returns the agents tuple [alice, bob].

src/alice-bob.ts#L276

Example:

const [alice, bob] = new Alice<Local, Remote>().agents()

// to enable debugging on local (alice)
const [alice, bob] = new Alice<Local, Remote>().agents({ debug: true })

// use different names:
const [alice, bob] = new Alice<Local, Remote>().agents(
  { name: 'server', debug: true },
  { name: 'client' }
)

# local

null | Partial<Agent<A, B>>

# remote

null | Partial<Agent<B, A>>

agents(local, remote)  =>

[ {
# debug – Whether or not to log debugging information.

src/alice-bob.ts#L32

boolean

# name – The name of the agent. Defaults to either 'alice' or 'bob' depending on the constructor used, Alice or Bob.

src/alice-bob.ts#L38

string

# send – The send method overriden by the user to any transport.

src/alice-bob.ts#L43

PayloadMethod<Agent<B, A>>

# deferredSend() – Returns the send method. Used in contexts where it might change between sessions, like browser refresh/hot/livereload.

src/alice-bob.ts#L49

deferredSend()  =>

PayloadMethod<Agent<B, A>>

# deserializer(data)

src/alice-bob.ts#L57

# data

unknown

deserializer(data)  =>

any

# log(args) – Overridable logging function. Defaults to console.log() and prepends agent.name.

src/alice-bob.ts#L63

# args

unknown []

log(args)  =>

void

# serializer(data)

src/alice-bob.ts#L56

# data

unknown

serializer(data)  =>

any

} & A & {
# target

src/alice-bob.ts#L95

A

}, Agent<B, A> ]

# deserializer(data)

src/alice-bob.ts#L108

# data

any

deserializer(data)  =>

any

# serializer(data)

src/alice-bob.ts#L107

# data

any

serializer(data)  =>

any

# Payload – Payload.

src/alice-bob.ts#L6

# args – The arguments passed to the method.

src/alice-bob.ts#L18

unknown []

# id – Payload id.

src/alice-bob.ts#L10

number

# method – Method to call.

src/alice-bob.ts#L14

keyof T

# Agent – Agent.

src/alice-bob.ts#L28

{

# debug – Whether or not to log debugging information.

src/alice-bob.ts#L32

boolean

# name – The name of the agent. Defaults to either 'alice' or 'bob' depending on the constructor used, Alice or Bob.

src/alice-bob.ts#L38

string

# send – The send method overriden by the user to any transport.

src/alice-bob.ts#L43

PayloadMethod<Agent<B, A>>

# deferredSend() – Returns the send method. Used in contexts where it might change between sessions, like browser refresh/hot/livereload.

src/alice-bob.ts#L49

deferredSend()  =>

PayloadMethod<Agent<B, A>>

# deserializer(data)

src/alice-bob.ts#L57

# data

unknown

deserializer(data)  =>

any

# log(args) – Overridable logging function. Defaults to console.log() and prepends agent.name.

src/alice-bob.ts#L63

# args

unknown []

log(args)  =>

void

# serializer(data)

src/alice-bob.ts#L56

# data

unknown

serializer(data)  =>

any

} & A

# PayloadMethod

src/alice-bob.ts#L21

# (payload)

# payload

Payload<T>

(payload)  =>

Promise<unknown> | unknown

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas