Class LargeArea

Large Area Master API.

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

Hierarchy

LargeArea

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new LargeArea(): LargeArea

- Defined in src/api/largeArea.ts:35
Returns LargeArea

Properties

Private _URL

_URL: string = ...

Private _keyManager

_keyManager: KeyManager = KeyManager.instance

Private _params

_params: LargeAreaSearchQuery = ...

Methods

keyword

keyword(keyword: string): LargeArea

- Defined in src/api/largeArea.ts:57
Sets large area name (partial match), specified in UTF8 (URL encoding)

memberof
LargeArea

Parameters
- keyword: string
  
  Large area keyword.
Returns LargeArea
{this}

largeArea

largeArea(...codes: string[]): LargeArea

- Defined in src/api/largeArea.ts:45
Sets large area code (exact match). (Up to 3 codes can be specified. If more than 4 codes are specified, the fourth and subsequent codes will be ignored.)

memberof
LargeArea

Parameters
- Rest ...codes: string[]
  
  Large area codes.
Returns LargeArea
{this}

search

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

- Defined in src/api/largeArea.ts:69
Search large areas.

memberof
LargeArea

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

Generated using TypeDoc