Class default

constructor

• new default(options): default

• Parameters

  • options: NgwConnectorOptions

  Returns default

emitter

id

options

resources

Optional user

Static errors

abort

• abort(): void

• Stop all api requests

  Returns void

apiRequest

• apiRequest<K, P>(name, params_?, requestOptions?): default<P[K]>

• Send request to NGW api router.

  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'
  
  

  Type Parameters

  • K extends keyof RequestItemsParamsMap

  • P extends RequestItemKeys = RequestItemKeys

  Parameters

  • name: K

    NGW route name from routes

  • params_: RequestItemsParams<K> = {}

  • requestOptions: RequestOptions<RequestMethods> = {}

    Request options

  Returns default<P[K]>

connect

• connect(): default<PyramidRoute>

• Establishing a connection with NextGIS Web to fulfill all other requests.

  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));
  

  Returns default<PyramidRoute>

delete

• delete<K>(name, options?, params?): default<DeleteRequestItemsResponseMap[K]>

• Shortcut method for send DELETE request to NGW.

  Type Parameters

  • K extends keyof RequestItemsParamsMap

  Parameters

  • name: K

    NGW route name from routes

  • Optional options: null | RequestOptions<RequestMethods>

    Request options

  • Optional params: RequestItemsParams<K>

    Request item params or query params

  Returns default<DeleteRequestItemsResponseMap[K]>

deleteResource

• deleteResource(resource): default<void>

• ResourcesControl.delete

  Parameters

  • resource: ResourceIdKeynameDef

  Returns default<void>

get

• get<K>(name, options?, params?): default<GetRequestItemsResponseMap[K]>

• Shortcut method for send GET request to NGW.

  Type Parameters

  • K extends keyof RequestItemsParamsMap

  Parameters

  • name: K

    NGW route name from routes

  • Optional options: null | RequestOptions<RequestMethods>

    Request options

  • Optional params: RequestItemsParams<K>

    Request item params or query params

  Returns default<GetRequestItemsResponseMap[K]>

getActiveApiRequests

• getActiveApiRequests(): default<any>[]

• Returns default<any>[]

getAuthorizationHeaders

• getAuthorizationHeaders(credentials?): undefined | RequestHeaders

• Obtaining the required Headers for authentication of requests in the NGW.

  Parameters

  • Optional credentials: Credentials

  Returns undefined | RequestHeaders

getResource

• getResource(resource, requestOptions?): default<undefined | ResourceItem>

• ResourcesControl.getOne

  Parameters

  • resource: ResourceDefinition

  • Optional requestOptions: RequestOptions<RequestMethods>

  Returns default<undefined | ResourceItem>

getResourceBy

• getResourceBy(resource): default<undefined | ResourceItem>

• Deprecated

  • use getResource

  Parameters

  • resource: DeepPartial<Resource>

  Returns default<undefined | ResourceItem>

getResourceById

• getResourceById(id): default<undefined | ResourceItem>

• Deprecated

  • use getResource

  Parameters

  • id: number

  Returns default<undefined | ResourceItem>

getResourceByKeyname

• getResourceByKeyname(keyname): default<undefined | ResourceItem>

• Deprecated

  • use getResource

  Parameters

  • keyname: string

  Returns default<undefined | ResourceItem>

getResourceChildren

• getResourceChildren(resource, requestOptions?): default<ResourceItem[]>

• ResourcesControl.getChildrenOf

  Parameters

  • resource: ResourceDefinition

  • Optional requestOptions: GetChildrenOfOptions

  Returns default<ResourceItem[]>

getResourceId

• getResourceId(resource, requestOptions?): default<undefined | number>

• ResourcesControl.getId

  Parameters

  • resource: ResourceDefinition

  • Optional requestOptions: RequestOptions<RequestMethods>

  Returns default<undefined | number>

getResourceIdOrFail

• getResourceIdOrFail(resource, requestOptions?): default<number>

• ResourcesControl.getIdOrFail

  Parameters

  • resource: ResourceDefinition

  • Optional requestOptions: RequestOptions<RequestMethods>

  Returns default<number>

getResourceOrFail

• getResourceOrFail(resource, requestOptions?): default<ResourceItem>

• ResourcesControl.getOneOrFail

  Parameters

  • resource: ResourceDefinition

  • Optional requestOptions: RequestOptions<RequestMethods>

  Returns default<ResourceItem>

getResourceParent

• getResourceParent(resource, requestOptions?): default<undefined | ResourceItem>

• ResourcesControl.getParent

  Parameters

  • resource: ResourceDefinition

  • Optional requestOptions: RequestOptions<RequestMethods>

  Returns default<undefined | ResourceItem>

getResourcesBy

• getResourcesBy(resource, requestOptions?): default<ResourceItem[]>

• ResourcesControl.getMany

  Parameters

  • resource: DeepPartial<Resource>

  • Optional requestOptions: RequestOptions<RequestMethods>

  Returns default<ResourceItem[]>

getUserInfo

• getUserInfo(credentials?, options?): default<UserInfo>

• Parameters

  • Optional credentials: Credentials

  • Optional options: RequestOptions<RequestMethods>

  Returns default<UserInfo>

login

• login(credentials, options?): default<UserInfo>

• Quick way to change NextGIS Web user.

  Parameters

  • credentials: Credentials

    New user credentials

  • Optional options: RequestOptions<RequestMethods>

  Returns default<UserInfo>

logout

• logout(): void

• Disconnecting a user. Aborting all current requests

  Returns void

makeClientId

• makeClientId(credentials?): undefined | string

• Parameters

  • Optional credentials: Credentials

  Returns undefined | string

makeQuery

• makeQuery<R>(url, params?, options?): default<R>

• Send request to NGW.

  Type Parameters

  • R = unknown

  Parameters

  • url: string

    URL address to NGW

  • Optional params: null | Params

    Query params

  • options: RequestOptions<RequestMethods> = {}

    Request options

  Returns default<R>

patch

• patch<K>(name, options?, params?): default<PatchRequestItemsResponseMap[K]>

• Shortcut method for send PATCH request to NGW.

  Type Parameters

  • K extends keyof RequestItemsParamsMap

  Parameters

  • name: K

    NGW route name from routes

  • Optional options: RequestOptions<RequestMethods>

    Request options

  • Optional params: RequestItemsParams<K>

    Request item params or query params

  Returns default<PatchRequestItemsResponseMap[K]>

post

• post<K>(name, options?, params?): default<PostRequestItemsResponseMap[K]>

• Shortcut method for send POST request to NGW.

  Example

  connector.post('resource.collection', { data: POST_PAYLOAD })
    .then((newResource) => console.log(newResource))
    .catch((error) => console.warn(error));
  

  Type Parameters

  • K extends keyof RequestItemsParamsMap

  Parameters

  • name: K

    NGW route name from routes

  • Optional options: RequestOptions<"POST">

    Request options

  • Optional params: RequestItemsParams<K>

    Request item params or query params

  Returns default<PostRequestItemsResponseMap[K]>

put

• put<K>(name, options?, params?): default<PutRequestItemsResponseMap[K]>

• Shortcut method for send PUT request to NGW.

  Type Parameters

  • K extends keyof RequestItemsParamsMap

  Parameters

  • name: K

    NGW route name from routes

  • Optional options: RequestOptions<RequestMethods>

    Request options

  • Optional params: RequestItemsParams<K>

    Request item params or query params

  Returns default<PutRequestItemsResponseMap[K]>

setNgw

• setNgw(baseUrl): void

• Fast way to specify the connection address to NextGIS Web. The current connection will be severed.

  Parameters

  • baseUrl: string

    NGW url

  Returns void

setRequestTransform

• setRequestTransform(requestTransform): void

• Parameters

  • requestTransform: undefined | null | RequestTransformFunction

  Returns void

updateResource

• updateResource(resource, data): default<undefined | ResourceItem>

• ResourcesControl.update

  Parameters

  • resource: ResourceIdKeynameDef

  • data: DeepPartial<ResourceItem>

  Returns default<undefined | ResourceItem>

Static create

• create(options): default

• Parameters

  • options: NgwConnectorOptions

  Returns default