Nymph.js 1.0.0-beta.113
Preparing search index...
@nymphjs/client
PubSub
Class PubSub
Index
Constructors
constructor
Methods
authenticate
close
connect
is
Connection
is
Connection
Connecting
is
Connection
Open
off
on
subscribe
Entities
subscribe
Entity
subscribe
UID
subscribe
With
update
Array
Constructors
constructor
new
PubSub
(
nymphOptions
:
NymphOptions
,
nymph
:
Nymph
)
:
PubSub
Parameters
nymphOptions
:
NymphOptions
nymph
:
Nymph
Returns
PubSub
Methods
authenticate
authenticate
(
authToken
:
string
|
null
,
switchToken
?:
string
|
null
)
:
void
Parameters
authToken
:
string
|
null
switchToken
:
string
|
null
= null
Returns
void
close
close
()
:
void
Returns
void
connect
connect
()
:
void
Returns
void
is
Connection
isConnection
()
:
boolean
Returns
boolean
is
Connection
Connecting
isConnectionConnecting
()
:
boolean
Returns
boolean
is
Connection
Open
isConnectionOpen
()
:
boolean
Returns
boolean
off
off
<
T
extends
PubSubEventType
>
(
event
:
T
,
callback
:
T
extends
"connect"
?
PubSubConnectCallback
:
T
extends
"disconnect"
?
PubSubDisconnectCallback
:
T
extends
"error"
?
PubSubErrorCallback
:
never
,
)
:
boolean
Type Parameters
T
extends
PubSubEventType
Parameters
event
:
T
callback
:
T
extends
"connect"
?
PubSubConnectCallback
:
T
extends
"disconnect"
?
PubSubDisconnectCallback
:
T
extends
"error"
?
PubSubErrorCallback
:
never
Returns
boolean
on
on
<
T
extends
PubSubEventType
>
(
event
:
T
,
callback
:
T
extends
"connect"
?
PubSubConnectCallback
:
T
extends
"disconnect"
?
PubSubDisconnectCallback
:
T
extends
"error"
?
PubSubErrorCallback
:
never
,
)
:
()
=>
boolean
Type Parameters
T
extends
PubSubEventType
Parameters
event
:
T
callback
:
T
extends
"connect"
?
PubSubConnectCallback
:
T
extends
"disconnect"
?
PubSubDisconnectCallback
:
T
extends
"error"
?
PubSubErrorCallback
:
never
Returns
()
=>
boolean
subscribe
Entities
subscribeEntities
<
T
extends
EntityConstructor
=
EntityConstructor
>
(
options
:
Options
<
T
>
&
{
return
:
"guid"
}
,
...
selectors
:
Selector
[]
,
)
:
PubSubSubscribable
<
PubSubUpdate
<
string
[]
>
>
Type Parameters
T
extends
EntityConstructor
=
EntityConstructor
Parameters
options
:
Options
<
T
>
&
{
return
:
"guid"
}
...
selectors
:
Selector
[]
Returns
PubSubSubscribable
<
PubSubUpdate
<
string
[]
>
>
subscribeEntities
<
T
extends
EntityConstructor
=
EntityConstructor
>
(
options
:
Options
<
T
>
,
...
selectors
:
Selector
[]
,
)
:
PubSubSubscribable
<
PubSubUpdate
<
EntityInstanceType
<
T
>
[]
>
>
Type Parameters
T
extends
EntityConstructor
=
EntityConstructor
Parameters
options
:
Options
<
T
>
...
selectors
:
Selector
[]
Returns
PubSubSubscribable
<
PubSubUpdate
<
EntityInstanceType
<
T
>
[]
>
>
subscribe
Entity
subscribeEntity
<
T
extends
EntityConstructor
=
EntityConstructor
>
(
options
:
Options
<
T
>
&
{
return
:
"guid"
}
,
...
selectors
:
Selector
[]
,
)
:
PubSubSubscribable
<
PubSubUpdate
<
string
|
null
>
>
Type Parameters
T
extends
EntityConstructor
=
EntityConstructor
Parameters
options
:
Options
<
T
>
&
{
return
:
"guid"
}
...
selectors
:
Selector
[]
Returns
PubSubSubscribable
<
PubSubUpdate
<
string
|
null
>
>
subscribeEntity
<
T
extends
EntityConstructor
=
EntityConstructor
>
(
options
:
Options
<
T
>
,
...
selectors
:
Selector
[]
,
)
:
PubSubSubscribable
<
PubSubUpdate
<
EntityInstanceType
<
T
>
|
null
>
>
Type Parameters
T
extends
EntityConstructor
=
EntityConstructor
Parameters
options
:
Options
<
T
>
...
selectors
:
Selector
[]
Returns
PubSubSubscribable
<
PubSubUpdate
<
EntityInstanceType
<
T
>
|
null
>
>
subscribe
UID
subscribeUID
(
name
:
string
,
)
:
(
resolve
?:
PubSubResolveCallback
<
number
>
,
reject
?:
PubSubRejectCallback
,
count
?:
PubSubCountCallback
,
)
=>
{
unsubscribe
:
()
=>
void
}
Parameters
name
:
string
Returns
(
resolve
?:
PubSubResolveCallback
<
number
>
,
reject
?:
PubSubRejectCallback
,
count
?:
PubSubCountCallback
,
)
=>
{
unsubscribe
:
()
=>
void
}
subscribe
With
subscribeWith
<
T
extends
EntityInterface
>
(
entity
:
T
,
resolve
?:
PubSubResolveCallback
<
T
>
,
reject
?:
PubSubRejectCallback
,
count
?:
PubSubCountCallback
,
)
:
PubSubSubscription
<
T
>
Type Parameters
T
extends
EntityInterface
Parameters
entity
:
T
Optional
resolve
:
PubSubResolveCallback
<
T
>
Optional
reject
:
PubSubRejectCallback
Optional
count
:
PubSubCountCallback
Returns
PubSubSubscription
<
T
>
update
Array
updateArray
(
current
:
EntityInterface
[]
,
update
:
PubSubUpdate
<
EntityInterface
[]
>
,
)
:
void
Parameters
current
:
EntityInterface
[]
update
:
PubSubUpdate
<
EntityInterface
[]
>
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
authenticate
close
connect
is
Connection
is
Connection
Connecting
is
Connection
Open
off
on
subscribe
Entities
subscribe
Entity
subscribe
UID
subscribe
With
update
Array
Nymph.js 1.0.0-beta.113
Loading...