@bzr/bazaar
Docs
Preparing search index...
TableAPI
Class TableAPI<T>
Internal
Type Parameters
T
extends
Doc
=
AnyDoc
Index
Constructors
constructor
Methods
delete
All
delete
One
get
All
get
One
get
Page
insert
One
replace
One
subscribe
All
subscribe
One
update
One
Constructors
constructor
new
TableAPI
<
T
extends
Doc
=
{
id
:
string
;
[
key
:
string
]:
unknown
;
[
key
:
number
]:
unknown
;
[
key
:
symbol
]:
unknown
;
}
,
>
(
api
:
API
,
tableName
:
string
,
)
:
TableAPI
<
T
>
Type Parameters
T
extends
Doc
=
{
id
:
string
;
[
key
:
string
]:
unknown
;
[
key
:
number
]:
unknown
;
[
key
:
symbol
]:
unknown
;
}
Parameters
api
:
API
tableName
:
string
Returns
TableAPI
<
T
>
Methods
delete
All
deleteAll
(
filter
?:
FilterObject
)
:
Promise
<
BazaarMessage
>
Parameters
filter
:
FilterObject
= {}
Returns
Promise
<
BazaarMessage
>
delete
One
deleteOne
(
rowId
:
string
)
:
Promise
<
BazaarMessage
>
Parameters
rowId
:
string
Returns
Promise
<
BazaarMessage
>
get
All
getAll
(
options
?:
{
endOffset
?:
number
;
filter
?:
FilterObject
;
limit
?:
number
;
orderBy
?:
OrderBy
;
select
?:
string
[]
;
startOffset
?:
number
;
}
,
)
:
Promise
<
T
[]
>
Parameters
options
:
{
endOffset
?:
number
;
filter
?:
FilterObject
;
limit
?:
number
;
orderBy
?:
OrderBy
;
select
?:
string
[]
;
startOffset
?:
number
;
}
= {}
Returns
Promise
<
T
[]
>
get
One
getOne
(
rowId
:
string
)
:
Promise
<
T
|
null
>
Parameters
rowId
:
string
Returns
Promise
<
T
|
null
>
get
Page
getPage
(
pageNumber
:
number
,
pageSize
:
number
,
options
?:
{
filter
?:
FilterObject
;
orderBy
?:
OrderBy
;
select
?:
string
[]
}
,
)
:
Promise
<
T
[]
>
Parameters
pageNumber
:
number
pageSize
:
number
options
:
{
filter
?:
FilterObject
;
orderBy
?:
OrderBy
;
select
?:
string
[]
}
= {}
Returns
Promise
<
T
[]
>
insert
One
insertOne
(
row
:
T
|
Omit
<
T
,
"id"
>
)
:
Promise
<
string
>
Parameters
row
:
T
|
Omit
<
T
,
"id"
>
Returns
Promise
<
string
>
The row ID
replace
One
replaceOne
(
rowId
:
string
,
row
:
T
|
Omit
<
T
,
"id"
>
)
:
Promise
<
BazaarMessage
>
Parameters
rowId
:
string
row
:
T
|
Omit
<
T
,
"id"
>
Returns
Promise
<
BazaarMessage
>
subscribe
All
subscribeAll
(
filter
:
FilterObject
,
listener
:
SubscribeListener
<
T
>
,
)
:
Promise
<
()
=>
Promise
<
string
>
>
Parameters
filter
:
FilterObject
listener
:
SubscribeListener
<
T
>
Returns
Promise
<
()
=>
Promise
<
string
>
>
An unsubscribe function
subscribe
One
subscribeOne
(
rowId
:
string
,
listener
:
SubscribeListener
<
T
>
,
)
:
Promise
<
()
=>
Promise
<
string
>
>
Parameters
rowId
:
string
listener
:
SubscribeListener
<
T
>
Returns
Promise
<
()
=>
Promise
<
string
>
>
An unsubscribe function
update
One
updateOne
(
rowId
:
string
,
row
:
DeepPartial
<
T
>
)
:
Promise
<
BazaarMessage
>
Parameters
rowId
:
string
row
:
DeepPartial
<
T
>
Returns
Promise
<
BazaarMessage
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
delete
All
delete
One
get
All
get
One
get
Page
insert
One
replace
One
subscribe
All
subscribe
One
update
One
Docs
@bzr/bazaar
Loading...