LocalityService

Locality service can be used in the following way:

1. Import the service from our library:

import {LocalityService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `getLocalities` will return the paginated list of localities.

async getLocalities() {
       return await LocalityService.getLocalities();
     }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

new LocalityService()

new LocalityService(): LocalityService

Returns

LocalityService

Methods

getLocalities()

static getLocalities(params?, config?): Promise <SCPaginatedResponse<SCLocalityType>>

Parameters

Parameter	Type
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCLocalityType>>

Source

services/locality/index.ts:71

---

searchLocalities()

static searchLocalities(params?, config?): Promise <SCPaginatedResponse<SCLocalityType>>

Parameters

Parameter	Type
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCLocalityType>>

Source

services/locality/index.ts:74