Search
Preparing search index...
The search index is not available
Detritus Client
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Detritus Client
collections/typing
TypingCollection
Class TypingCollection
Typing Collection, a collection of users currently typing
Hierarchy
BaseClientCollectionCache
<
string
,
Typing
>
TypingCollection
Index
Constructors
constructor
Properties
caches
client
enabled
options
Accessors
[
Symbol.to
String
Tag]
length
size
Methods
[
Symbol.iterator]
clear
delete
entries
every
filter
find
first
for
Each
get
has
insert
insert
Cache
join
keys
map
reduce
set
set
Enabled
some
sort
to
Array
toJSON
to
String
values
Constructors
constructor
new
Typing
Collection
(
client
:
ShardClient
, options
?:
boolean
|
BaseClientCollectionOptions
)
:
TypingCollection
Parameters
client:
ShardClient
options:
boolean
|
BaseClientCollectionOptions
= {}
Returns
TypingCollection
Properties
Readonly
caches
caches
:
BaseCollection
<
string
,
BaseCollection
<
string
,
Typing
>
>
= ...
client
client
:
ShardClient
enabled
enabled
:
boolean
Readonly
options
options
:
BaseCollectionOptions
= {}
Accessors
[
Symbol.to
String
Tag]
get
[Symbol.toStringTag]
(
)
:
string
Returns
string
length
get
length
(
)
:
number
Returns
number
size
get
size
(
)
:
number
Returns
number
Methods
[
Symbol.iterator]
[
Symbol.iterator]
(
)
:
IterableIterator
<
[
string
,
Typing
]
>
Returns
IterableIterator
<
[
string
,
Typing
]
>
clear
clear
(
)
:
void
Returns
void
delete
delete
(
cacheKey
:
string
)
:
boolean
delete
(
cacheKey
:
undefined
|
null
|
string
, key
:
string
)
:
boolean
Parameters
cacheKey:
string
Returns
boolean
Parameters
cacheKey:
undefined
|
null
|
string
key:
string
Returns
boolean
entries
entries
(
)
:
IterableIterator
<
[
string
,
Typing
]
>
Returns
IterableIterator
<
[
string
,
Typing
]
>
every
every
(
func
:
(
v
:
Typing
, k
:
string
)
=>
boolean
)
:
boolean
Parameters
func:
(
v
:
Typing
, k
:
string
)
=>
boolean
(
v
:
Typing
, k
:
string
)
:
boolean
Parameters
v:
Typing
k:
string
Returns
boolean
Returns
boolean
filter
filter
(
func
:
(
v
:
Typing
, k
:
string
)
=>
boolean
)
:
Typing
[]
Parameters
func:
(
v
:
Typing
, k
:
string
)
=>
boolean
(
v
:
Typing
, k
:
string
)
:
boolean
Parameters
v:
Typing
k:
string
Returns
boolean
Returns
Typing
[]
find
find
(
func
:
(
v
:
Typing
, k
:
string
)
=>
boolean
)
:
undefined
|
Typing
Parameters
func:
(
v
:
Typing
, k
:
string
)
=>
boolean
(
v
:
Typing
, k
:
string
)
:
boolean
Parameters
v:
Typing
k:
string
Returns
boolean
Returns
undefined
|
Typing
first
first
(
)
:
undefined
|
Typing
Returns
undefined
|
Typing
for
Each
for
Each
(
func
:
(
v
:
Typing
, k
:
string
, map
:
Map
<
string
,
Typing
>
)
=>
void
, thisArg
?:
any
)
:
void
Parameters
func:
(
v
:
Typing
, k
:
string
, map
:
Map
<
string
,
Typing
>
)
=>
void
(
v
:
Typing
, k
:
string
, map
:
Map
<
string
,
Typing
>
)
:
void
Parameters
v:
Typing
k:
string
map:
Map
<
string
,
Typing
>
Returns
void
Optional
thisArg:
any
Returns
void
get
get
(
cacheKey
:
string
)
:
undefined
|
BaseCollection
<
string
,
Typing
>
get
(
cacheKey
:
undefined
|
null
|
string
, key
:
string
)
:
undefined
|
Typing
Parameters
cacheKey:
string
Returns
undefined
|
BaseCollection
<
string
,
Typing
>
Parameters
cacheKey:
undefined
|
null
|
string
key:
string
Returns
undefined
|
Typing
has
has
(
cacheKey
:
string
)
:
boolean
has
(
cacheKey
:
undefined
|
null
|
string
, key
:
string
)
:
boolean
Parameters
cacheKey:
string
Returns
boolean
Parameters
cacheKey:
undefined
|
null
|
string
key:
string
Returns
boolean
insert
insert
(
typing
:
Typing
)
:
void
Parameters
typing:
Typing
Returns
void
insert
Cache
insert
Cache
(
cacheKey
:
string
)
:
BaseCollection
<
string
,
Typing
>
Parameters
cacheKey:
string
Returns
BaseCollection
<
string
,
Typing
>
join
join
(
separator
?:
string
)
:
string
Parameters
Optional
separator:
string
Returns
string
keys
keys
(
)
:
IterableIterator
<
string
>
Returns
IterableIterator
<
string
>
map
map
(
func
:
(
v
:
Typing
, k
:
string
)
=>
any
)
:
any
[]
Parameters
func:
(
v
:
Typing
, k
:
string
)
=>
any
(
v
:
Typing
, k
:
string
)
:
any
Parameters
v:
Typing
k:
string
Returns
any
Returns
any
[]
reduce
reduce
(
func
:
(
intial
:
any
, v
:
Typing
)
=>
any
, initialValue
?:
any
)
:
any
Parameters
func:
(
intial
:
any
, v
:
Typing
)
=>
any
(
intial
:
any
, v
:
Typing
)
:
any
Parameters
intial:
any
v:
Typing
Returns
any
Optional
initialValue:
any
Returns
any
set
set
(
cacheKey
:
string
, key
:
string
, value
:
Typing
)
:
TypingCollection
Parameters
cacheKey:
string
key:
string
value:
Typing
Returns
TypingCollection
set
Enabled
set
Enabled
(
value
:
boolean
)
:
void
Parameters
value:
boolean
Returns
void
some
some
(
func
:
(
v
:
Typing
, k
:
string
)
=>
boolean
)
:
boolean
Parameters
func:
(
v
:
Typing
, k
:
string
)
=>
boolean
(
v
:
Typing
, k
:
string
)
:
boolean
Parameters
v:
Typing
k:
string
Returns
boolean
Returns
boolean
sort
sort
(
func
?:
(
x
:
Typing
, y
:
Typing
)
=>
number
)
:
Typing
[]
Parameters
Optional
func:
(
x
:
Typing
, y
:
Typing
)
=>
number
(
x
:
Typing
, y
:
Typing
)
:
number
Parameters
x:
Typing
y:
Typing
Returns
number
Returns
Typing
[]
to
Array
to
Array
(
)
:
Typing
[]
Returns
Typing
[]
toJSON
toJSON
(
)
:
Typing
[]
Returns
Typing
[]
to
String
to
String
(
)
:
string
Returns
string
values
values
(
)
:
IterableIterator
<
Typing
>
Returns
IterableIterator
<
Typing
>
Exports
collections/typing
Typing
Collection
constructor
caches
client
enabled
options
[
Symbol.to
String
Tag]
length
size
[
Symbol.iterator]
clear
delete
entries
every
filter
find
first
for
Each
get
has
insert
insert
Cache
join
keys
map
reduce
set
set
Enabled
some
sort
to
Array
toJSON
to
String
values
Typing
Options
Generated using
TypeDoc
Typing Collection, a collection of users currently typing