Search
Preparing search index...
The search index is not available
@bullhorn/taurus
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
SearchService
Class SearchService<T>
A class for making Search calls via Rest
Type parameters
T
Hierarchy
QueryService
<
T
>
SearchService
Index
Constructors
constructor
Properties
_endpoint
_last
Response
_page
entity
http
meta
records
Accessors
endpoint
snapshot
total
Methods
count
fields
get
nextpage
page
params
query
run
sort
then
where
Object literals
parameters
Constructors
constructor
new
Search
Service
(
entity
:
any
)
:
SearchService
constructor description
Parameters
entity:
any
Returns
SearchService
Properties
Protected
_endpoint
_endpoint
:
string
Protected
_last
Response
_last
Response
:
BullhornListResponse
<
T
>
Protected
_page
_page
:
number
= 0
entity
entity
:
string
http
http
:
AxiosInstance
meta
meta
:
MetaService
records
records
:
any
[]
= []
Accessors
endpoint
get
endpoint
(
)
:
string
set
endpoint
(
value
:
string
)
:
void
Returns
string
Parameters
value:
string
Returns
void
snapshot
get
snapshot
(
)
:
BullhornListResponse
<
T
>
Returns
BullhornListResponse
<
T
>
total
get
total
(
)
:
Promise
<
number
>
Returns
Promise
<
number
>
Methods
count
count
(
value
:
number
)
:
this
Parameters
value:
number
Returns
this
fields
fields
(
...
args
:
any
[]
)
:
this
Parameters
Rest
...
args:
any
[]
Returns
this
get
get
(
add
:
any
)
:
Promise
<
BullhornListResponse
<
T
>
>
Parameters
add:
any
Returns
Promise
<
BullhornListResponse
<
T
>
>
nextpage
nextpage
(
)
:
Promise
<
BullhornListResponse
<
T
>
>
Returns
Promise
<
BullhornListResponse
<
T
>
>
page
page
(
value
:
number
)
:
this
Parameters
value:
number
Returns
this
params
params
(
object
:
any
)
:
this
Parameters
object:
any
Returns
this
query
query
(
value
:
any
)
:
this
Parameters
value:
any
Returns
this
run
run
(
add
:
any
)
:
Promise
<
BullhornListResponse
<
T
>
>
Parameters
add:
any
Returns
Promise
<
BullhornListResponse
<
T
>
>
sort
sort
(
...
args
:
any
[]
)
:
this
Parameters
Rest
...
args:
any
[]
Returns
this
then
then
(
done
:
any
, fail
?:
any
)
:
Promise
<
any
>
Parameters
done:
any
Optional
fail:
any
Returns
Promise
<
any
>
where
where
(
value
:
any
)
:
this
Parameters
value:
any
Returns
this
Object literals
parameters
parameters
:
object
count
count
:
number
= 10
fields
fields
:
string
[]
= ['id']
order
By
order
By
:
string
[]
= ['-dateAdded']
start
start
:
number
= 0
Globals
Search
Service
constructor
_endpoint
_last
Response
_page
entity
http
meta
records
endpoint
snapshot
total
count
fields
get
nextpage
page
params
query
run
sort
then
where
parameters
Generated using
TypeDoc
A class for making Search calls via Rest