import RemoteLibrary from 'remote-lib/lib/RemoteLibrary.js'

public class | source

RemoteLibrary

A remote library connected with duplex stream to a local Library.

Example:

import { RemoteLibrary } from 'remote-lib';

const remoteLibrary = new RemoteLibrary(stream);

Constructor Summary

Public Constructor
public	constructor(stream: Duplex, opts: object): RemoteLibrary Create a remote library with a duplex stream to a local Library.

Member Summary

Public Members
public get	context: RemoteContext: * Get the library remote context.

Method Summary

Public Methods
public	delete(reference: Reference): boolean Delete a reference from RemoteContext.
public	destroy(): void Destroy RemoteContext.
public	get(reference: Reference): RemotePromise Fetch a reference value from RemoteContext.
public	on(eventName: string, listener: function): RemoteLibrary Bind a listener to the RemoteContext.
public	once(eventName: string, listener: function): RemoteLibrary Bind a listener once to the RemoteContext.
public	release(value: RemoteValueProxy): boolean Release a value from RemoteContext.
public	removeListener(eventName: string, listener: function): RemoteLibrary Remove a listener from the RemoteContext.
public	resolve(value: *): RemotePromise Resolve a value with RemoteContext.

Public Constructors

public constructor(stream: Duplex, opts: object): RemoteLibrary source

Create a remote library with a duplex stream to a local Library.

Params:

Name	Type	Attribute	Description
stream	Duplex		A duplex stream to the local library
opts	object	optional	Options to Context and RemoteSession

Return:

RemoteLibrary

Public Members

public get context: RemoteContext: * source

Get the library remote context.

Return:

RemoteContext

Public Methods

public delete(reference: Reference): boolean source

Delete a reference from RemoteContext.

Params:

Name	Type	Attribute	Description
reference	Reference

Return:

void

See:

RemoteContext#destroy

public get(reference: Reference): RemotePromise source

Fetch a reference value from RemoteContext.

Params:

Name	Type	Attribute	Description
reference	Reference

Return:

RemotePromise

See:

RemoteContext#fetch

public on(eventName: string, listener: function): RemoteLibrary source

Bind a listener to the RemoteContext.

Params:

Name	Type	Attribute	Description
eventName	string
listener	function

Return:

RemoteLibrary

See:

RemoteContext#on

public once(eventName: string, listener: function): RemoteLibrary source

Bind a listener once to the RemoteContext.

Params:

Name	Type	Attribute	Description
eventName	string
listener	function

Return:

RemoteLibrary

See:

RemoteContext#once

public release(value: RemoteValueProxy): boolean source

Release a value from RemoteContext.

Params:

Name	Type	Attribute	Description
value	RemoteValueProxy

Return:

boolean

See:

RemoteContext#release

public removeListener(eventName: string, listener: function): RemoteLibrary source

Remove a listener from the RemoteContext.

Params:

Name	Type	Attribute	Description
eventName	string
listener	function

Return:

RemoteLibrary

See:

RemoteContext#removeListener

public resolve(value: *): RemotePromise source

Resolve a value with RemoteContext.

Params:

Name	Type	Attribute	Description
value	*

Return:

RemotePromise

See:

RemoteContext#resolve

RemoteLibrary

Example:

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(stream: Duplex, opts: object): RemoteLibrary source

Params:

Return:

Public Members

public get context: RemoteContext: * source

Return:

Public Methods

public delete(reference: Reference): boolean source

Params:

Return:

See:

public destroy(): void source

Return:

See:

public get(reference: Reference): RemotePromise source

Params:

Return:

See:

public on(eventName: string, listener: function): RemoteLibrary source

Params:

Return:

See:

public once(eventName: string, listener: function): RemoteLibrary source

Params:

Return:

See:

public release(value: RemoteValueProxy): boolean source

Params:

Return:

See:

public removeListener(eventName: string, listener: function): RemoteLibrary source

Params:

Return:

See:

public resolve(value: *): RemotePromise source

Params:

Return:

See: