Class default

Hierarchy

NgwConnector
- default

Constructors

constructor

new default(options: NgwConnectorOptions): default
Parameters
- options: NgwConnectorOptions
Returns default
Overrides NgwConnector.constructor
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:33

Properties

cache

cache: default

emitter

emitter: EventEmitter<DefaultEventMap> = ...

id

id: number = ...

options

options: NgwConnectorOptions

resources

resources: ResourcesControl

`Optional`user

user?: UserInfo

`Optional`withCredentials

withCredentials?: boolean = undefined

`Static`errors

errors: __module = errors

Methods

`Protected`_loadData

_loadData<R = unknown>(url: string, options: RequestOptions): Promise<R>
Type Parameters
- R = unknown
Parameters
- url: string
- options: RequestOptions
Returns Promise<R>
Inherited from NgwConnector._loadData
- Defined in packages/ngw-connector/src/NgwConnector.ts:301

abort

abort(): void
Stop all api requests

Returns void
Inherited from NgwConnector.abort
- Defined in packages/ngw-connector/src/NgwConnector.ts:204

apiRequest

apiRequest<
    K extends keyof RequestItemsParamsMap,
    P extends RequestItemKeys = RequestItemKeys,
>(
    name: K,
    params_?: RequestItemsParams<K>,
    requestOptions?: RequestOptions,
): Promise<P[K]>

Send request to NGW api router.

Type Parameters

K extends keyof RequestItemsParamsMap
P extends RequestItemKeys = RequestItemKeys

Parameters

name: K
NGW route name from routes
params_: RequestItemsParams<K> = {}
requestOptions: RequestOptions = {}
Request options

Returns Promise<P[K]>

Example


// there is such an NGW route item
// "feature_layer.feature.item": [
//   "/api/resource/{0}/feature/{1}",
//   "id",
//   "fid"
// ],

const connector = new NgwConnector({ baseUrl: 'https://example.nextgis.com' });
connector.apiRequest('feature_layer.feature.item', {
  // request params for {0} and {1}
  'id': 2011,
  'fid': 101,
  // query params
  'srs': 4326,
  'geom_format': 'geojson',
}, { method: 'GET' });
// send get-request to 'https://example.nextgis.com/api/resource/2011/feature/101?srs=4326&geom_format=geojson'

clearCache

clearCache(): void
Clear the cache.

Returns void
Overrides NgwConnector.clearCache
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:48

connect

connect(
    __namedParameters?: Pick<
        RequestOptions<RequestMethods, keyof RequestItemsParamsMap>,
        "signal",
    >,
): Promise<PyramidRoute>
Establishing a connection with NextGIS Web to fulfill all other requests.
Parameters
- __namedParameters: Pick<RequestOptions<RequestMethods, keyof RequestItemsParamsMap>, "signal"> = {}
Returns Promise<PyramidRoute>
Remarks
This method need not be called manually as it is used when forming a request in apiRequest. Can be used to check connection.
Example
```
const connector = new NgwConnector({ baseUrl: 'https://demo.nextgis.com' });
connector.connect()
  .then(() => console.log('Ok'))
  .catch((er) => console.log('Connection problem', er));
```
Inherited from NgwConnector.connect
- Defined in packages/ngw-connector/src/NgwConnector.ts:112

delete

delete<K extends keyof RequestItemsParamsMap>(
    name: K,
    options?: null | RequestOptions<"DELETE", K>,
    params?: RequestItemsParams<K>,
): Promise<DeleteRequestItemsResponseMap[K]>
Shortcut method for send DELETE request to NGW.
Type Parameters
- K extends keyof RequestItemsParamsMap
Parameters
- name: K
  NGW route name from routes
- Optionaloptions: null | RequestOptions<"DELETE", K>
  Request options
- Optionalparams: RequestItemsParams<K>
  Request item params or query params
Returns Promise<DeleteRequestItemsResponseMap[K]>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:188

deleteResource

deleteResource(resource: ResourceIdKeynameDef): Promise<void>
ResourcesControl.delete
Parameters
- resource: ResourceIdKeynameDef
Returns Promise<void>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:312

get

get<K extends keyof RequestItemsParamsMap>(
    name: K,
    options?: null | RequestOptions<"GET", K>,
    params?: RequestItemsParams<K>,
): Promise<GetRequestItemsResponseMap[K]>
Shortcut method for send GET request to NGW.
Type Parameters
- K extends keyof RequestItemsParamsMap
Parameters
- name: K
  NGW route name from routes
- Optionaloptions: null | RequestOptions<"GET", K>
  Request options
- Optionalparams: RequestItemsParams<K>
  Request item params or query params
Returns Promise<GetRequestItemsResponseMap[K]>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:128

getActiveApiRequests

getActiveApiRequests(): { [requestId: number]: AbortController }
Returns { [requestId: number]: AbortController }
Inherited from NgwConnector.getActiveApiRequests
- Defined in packages/ngw-connector/src/NgwConnector.ts:211

getAuthorizationHeaders

getAuthorizationHeaders(credentials?: Credentials): RequestHeaders
Obtaining the required Headers for authentication of requests in the NGW.
Parameters
- Optionalcredentials: Credentials
Returns RequestHeaders
Inherited from NgwConnector.getAuthorizationHeaders
- Defined in packages/ngw-connector/src/NgwConnector.ts:179

getResource

getResource(
resource: ResourceDefinition,
requestOptions?: GetRequestOptions<any, "json", false>,
): Promise<undefined | CompositeRead>
ResourcesControl.getOne
Parameters
- resource: ResourceDefinition
- OptionalrequestOptions: GetRequestOptions<any, "json", false>
Returns Promise<undefined | CompositeRead>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:209

getResourceBy

getResourceBy(
resource: DeepPartial<ResourceRead>,
): Promise<undefined | CompositeRead>
Parameters
- resource: DeepPartial<ResourceRead>
Returns Promise<undefined | CompositeRead>
Deprecated
- use getResource
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:229

getResourceById

getResourceById(id: number): Promise<undefined | CompositeRead>
Parameters
- id: number
Returns Promise<undefined | CompositeRead>
Deprecated
- use getResource
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:245

getResourceByKeyname

getResourceByKeyname(keyname: string): Promise<undefined | CompositeRead>
Parameters
- keyname: string
Returns Promise<undefined | CompositeRead>
Deprecated
- use getResource
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:238

getResourceChildren

getResourceChildren(
resource: ResourceDefinition,
requestOptions?: GetChildrenOfOptions,
): Promise<CompositeRead[]>
ResourcesControl.getChildrenOf
Parameters
- resource: ResourceDefinition
- OptionalrequestOptions: GetChildrenOfOptions
Returns Promise<CompositeRead[]>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:292

getResourceId

getResourceId(
resource: ResourceDefinition,
requestOptions?: GetRequestOptions<any, "json", false>,
): Promise<undefined | number>
ResourcesControl.getId
Parameters
- resource: ResourceDefinition
- OptionalrequestOptions: GetRequestOptions<any, "json", false>
Returns Promise<undefined | number>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:252

getResourceIdOrFail

getResourceIdOrFail(
resource: ResourceDefinition,
requestOptions?: GetRequestOptions<any, "json", false>,
): Promise<number>
ResourcesControl.getIdOrFail
Parameters
- resource: ResourceDefinition
- OptionalrequestOptions: GetRequestOptions<any, "json", false>
Returns Promise<number>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:262

getResourceOrFail

getResourceOrFail(
resource: ResourceDefinition,
requestOptions?: GetRequestOptions<any, "json", false>,
): Promise<CompositeRead>
ResourcesControl.getOneOrFail
Parameters
- resource: ResourceDefinition
- OptionalrequestOptions: GetRequestOptions<any, "json", false>
Returns Promise<CompositeRead>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:219

getResourceParent

getResourceParent(
resource: ResourceDefinition,
requestOptions?: GetRequestOptions<any, "json", false>,
): Promise<undefined | CompositeRead>
ResourcesControl.getParent
Parameters
- resource: ResourceDefinition
- OptionalrequestOptions: GetRequestOptions<any, "json", false>
Returns Promise<undefined | CompositeRead>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:282

getResourcesBy

getResourcesBy(
resource: DeepPartial<ResourceRead>,
requestOptions?: GetRequestOptions<any, "json", false>,
): Promise<CompositeRead[]>
ResourcesControl.getMany
Parameters
- resource: DeepPartial<ResourceRead>
- OptionalrequestOptions: GetRequestOptions<any, "json", false>
Returns Promise<CompositeRead[]>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:272

getUserInfo

getUserInfo(
credentials?: Credentials,
options?: RequestOptions<RequestMethods, keyof RequestItemsParamsMap>,
): Promise<UserInfo>
Parameters
- Optionalcredentials: Credentials
- Optionaloptions: RequestOptions<RequestMethods, keyof RequestItemsParamsMap>
Returns Promise<UserInfo>
Inherited from NgwConnector.getUserInfo
- Defined in packages/ngw-connector/src/NgwConnector.ts:152

login(
credentials: Credentials,
options?: RequestOptions<RequestMethods, keyof RequestItemsParamsMap>,
): Promise<UserInfo>
Quick way to change NextGIS Web user.
Parameters
- credentials: Credentials
  New user credentials
- Optionaloptions: RequestOptions<RequestMethods, keyof RequestItemsParamsMap>
Returns Promise<UserInfo>
Inherited from NgwConnector.login
- Defined in packages/ngw-connector/src/NgwConnector.ts:133

logout

logout(): void
Disconnecting a user. Aborting all current requests

Returns void
Inherited from NgwConnector.logout
- Defined in packages/ngw-connector/src/NgwConnector.ts:142

makeClientId

makeClientId(credentials?: Credentials): undefined | string
Parameters
- Optionalcredentials: Credentials
Returns undefined | string
Inherited from NgwConnector.makeClientId
- Defined in packages/ngw-connector/src/NgwConnector.ts:189

makeQuery

makeQuery<R = unknown>(
    url: string,
    params?: null | Params,
    options?: RequestOptions,
): Promise<R>
Send request to NGW.
Type Parameters
- R = unknown
Parameters
- url: string
  URL address to NGW
- Optionalparams: null | Params
  Query params
- options: RequestOptions = {}
  Request options
Returns Promise<R>
Inherited from NgwConnector.makeQuery
- Defined in packages/ngw-connector/src/NgwConnector.ts:225

patch

patch<K extends keyof RequestItemsParamsMap>(
    name: K,
    options?: RequestOptions<"PATCH", K>,
    params?: RequestItemsParams<K>,
): Promise<PatchRequestItemsResponseMap[K]>
Shortcut method for send PATCH request to NGW.
Type Parameters
- K extends keyof RequestItemsParamsMap
Parameters
- name: K
  NGW route name from routes
- Optionaloptions: RequestOptions<"PATCH", K>
  Request options
- Optionalparams: RequestItemsParams<K>
  Request item params or query params
Returns Promise<PatchRequestItemsResponseMap[K]>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:148

post

post<K extends keyof RequestItemsParamsMap>(
    name: K,
    options?: RequestOptions<"POST", K>,
    params?: RequestItemsParams<K>,
): Promise<PostRequestItemsResponseMap[K]>
Shortcut method for send POST request to NGW.
Type Parameters
- K extends keyof RequestItemsParamsMap
Parameters
- name: K
  NGW route name from routes
- Optionaloptions: RequestOptions<"POST", K>
  Request options
- Optionalparams: RequestItemsParams<K>
  Request item params or query params
Returns Promise<PostRequestItemsResponseMap[K]>
Example
```
connector.post('resource.collection', { data: POST_PAYLOAD })
  .then((newResource) => console.log(newResource))
  .catch((error) => console.warn(error));
```
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:108

put

put<K extends keyof RequestItemsParamsMap>(
    name: K,
    options?: RequestOptions<"PUT", K>,
    params?: RequestItemsParams<K>,
): Promise<PutRequestItemsResponseMap[K]>
Shortcut method for send PUT request to NGW.
Type Parameters
- K extends keyof RequestItemsParamsMap
Parameters
- name: K
  NGW route name from routes
- Optionaloptions: RequestOptions<"PUT", K>
  Request options
- Optionalparams: RequestItemsParams<K>
  Request item params or query params
Returns Promise<PutRequestItemsResponseMap[K]>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:168

route

route<N extends keyof Routes>(
name: N,
...rest: RouteParameters[N],
): RouteResults<N>
Type Parameters
- N extends keyof Routes
Parameters
- name: N
- ...rest: RouteParameters[N]
Returns RouteResults<N>
Inherited from NgwConnector.route
- Defined in packages/ngw-connector/src/NgwConnector.ts:215

setNgw

setNgw(baseUrl: string): void
Fast way to specify the connection address to NextGIS Web. The current connection will be severed.
Parameters
- baseUrl: string
  NGW url
Returns void
Inherited from NgwConnector.setNgw
- Defined in packages/ngw-connector/src/NgwConnector.ts:93

setRequestTransform

setRequestTransform(
requestTransform: undefined | null | RequestTransformFunction,
): void
Parameters
- requestTransform: undefined | null | RequestTransformFunction
Returns void
Inherited from NgwConnector.setRequestTransform
- Defined in packages/ngw-connector/src/NgwConnector.ts:82

updateResource

updateResource(
resource: ResourceIdKeynameDef,
data: DeepPartial<CompositeRead>,
): Promise<undefined | CompositeRead>
ResourcesControl.update
Parameters
- resource: ResourceIdKeynameDef
- data: DeepPartial<CompositeRead>
Returns Promise<undefined | CompositeRead>
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:302

`Static`create

create(options: NgwConnectorOptions): default
Parameters
- options: NgwConnectorOptions
Returns default
- Defined in packages/ngw-connector/src/NgwConnectorExtended.ts:41

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

cache

emitter

id

options

resources

Optionaluser

OptionalwithCredentials

Staticerrors

Methods

Protected_loadData

Type Parameters

Parameters

Returns Promise<R>

abort

Returns void

apiRequest

Type Parameters

Parameters

Returns Promise<P[K]>

Example

clearCache

Returns void

connect

Parameters

Returns Promise<PyramidRoute>

Remarks

Example

delete

Type Parameters

Parameters

Returns Promise<DeleteRequestItemsResponseMap[K]>

deleteResource

Parameters

Returns Promise<void>

get

Type Parameters

Parameters

Returns Promise<GetRequestItemsResponseMap[K]>

getActiveApiRequests

Returns { [requestId: number]: AbortController }

getAuthorizationHeaders

Parameters

Returns RequestHeaders

getResource

Parameters

Returns Promise<undefined | CompositeRead>

getResourceBy

Parameters

Returns Promise<undefined | CompositeRead>

Deprecated

getResourceById

Parameters

Returns Promise<undefined | CompositeRead>

Deprecated

getResourceByKeyname

Parameters

Returns Promise<undefined | CompositeRead>

Deprecated

getResourceChildren

Parameters

Returns Promise<CompositeRead[]>

getResourceId

Parameters

Returns Promise<undefined | number>

getResourceIdOrFail

Parameters

Returns Promise<number>

getResourceOrFail

Parameters

`Optional`user

`Optional`withCredentials

`Static`errors

`Protected`_loadData

`Static`create