Optional
userOptional
withStatic
errorsProtected
_loadSend request to NGW api router.
NGW route name from routes
Request options
// 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'
Establishing a connection with NextGIS Web to fulfill all other requests.
This method need not be called manually as it is used when forming a request in apiRequest. Can be used to check connection.
Shortcut method for send DELETE request to NGW.
NGW route name from routes
Optional
options: null | RequestOptions<"DELETE", K>Request options
Optional
params: RequestItemsParams<K>Request item params or query params
ResourcesControl.delete
Shortcut method for send GET request to NGW.
NGW route name from routes
Optional
options: null | RequestOptions<"GET", K>Request options
Optional
params: RequestItemsParams<K>Request item params or query params
Obtaining the required Headers for authentication of requests in the NGW.
Optional
credentials: CredentialsResourcesControl.getOne
Optional
requestOptions: GetRequestOptions<any, "json", false>ResourcesControl.getChildrenOf
Optional
requestOptions: GetChildrenOfOptionsResourcesControl.getId
Optional
requestOptions: GetRequestOptions<any, "json", false>ResourcesControl.getIdOrFail
Optional
requestOptions: GetRequestOptions<any, "json", false>ResourcesControl.getOneOrFail
Optional
requestOptions: GetRequestOptions<any, "json", false>ResourcesControl.getParent
Optional
requestOptions: GetRequestOptions<any, "json", false>ResourcesControl.getMany
Optional
requestOptions: GetRequestOptions<any, "json", false>Optional
credentials: CredentialsOptional
options: RequestOptions<RequestMethods, keyof RequestItemsParamsMap>Quick way to change NextGIS Web user.
New user credentials
Optional
options: RequestOptions<RequestMethods, keyof RequestItemsParamsMap>Optional
credentials: CredentialsSend request to NGW.
URL address to NGW
Optional
params: null | ParamsQuery params
Request options
Shortcut method for send PATCH request to NGW.
NGW route name from routes
Optional
options: RequestOptions<"PATCH", K>Request options
Optional
params: RequestItemsParams<K>Request item params or query params
Shortcut method for send POST request to NGW.
NGW route name from routes
Optional
options: RequestOptions<"POST", K>Request options
Optional
params: RequestItemsParams<K>Request item params or query params
Shortcut method for send PUT request to NGW.
NGW route name from routes
Optional
options: RequestOptions<"PUT", K>Request options
Optional
params: RequestItemsParams<K>Request item params or query params
Rest
...rest: RouteParameters[N]ResourcesControl.update
Static
create
Stop all api requests