Class Special

Special Master API.

export
see: https://webservice.recruit.co.jp/doc/hotpepper/reference.html

Hierarchy

Special

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Special(): Special

- Defined in src/api/special.ts:33
Returns Special

Properties

Private _URL

_URL: string = ...

Private _keyManager

_keyManager: KeyManager = KeyManager.instance

Private _params

_params: SpecialSearchQuery = ...

Methods

search

search(): Promise<HotPepperResponse<ResponseField<SpecialResponse>>>

- Defined in src/api/special.ts:66
Search special categories.

memberof
Special

Returns Promise<HotPepperResponse<ResponseField<SpecialResponse>>>
{Promise<HotPepperResponse<ResponseField>>}

special

special(special: string): Special

- Defined in src/api/special.ts:42
Sets special codes (exact match). Multiple search is possible.

memberof
Special

Parameters
- special: string
  
  Special codes.
Returns Special
{this}

specialCategory

specialCategory(specialCategory: string): Special

- Defined in src/api/special.ts:54
Sets special category codes (exact match). Multiple ones can be specified.

memberof
Special

Parameters
- specialCategory: string
  
  Special category codes.
Returns Special
{this}

Generated using TypeDoc