NextGIS Frontend
    Preparing search index...

    Interface NgwUploadOptions

    interface NgwUploadOptions {
        auth?: Credentials;
        baseUrl?: string;
        cacheId?: string;
        connector?: default;
        requestTransform?: RequestTransformFunction;
        route?: string;
        useTus?: boolean;
        withCredentials?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    auth? baseUrl? cacheId? connector? requestTransform? route? useTus? withCredentials?

    Properties

    auth?: Credentials

    User credentials for authorization in NGW. These credentials will be used for authentication in NGW requests.

    baseUrl?: string

    The base URL of the NextGIS Web (NGW) server. Example: "https://demo.nextgis.com"

    cacheId?: string

    Identifier for caching requests. This can be used to segregate cached data for different connectors.

    connector?: default
    requestTransform?: RequestTransformFunction

    A function to transform the request before sending it. This function can be used to modify the URL, headers, or other options.

    route?: string

    The API route path to use for requests. If not specified, the default route "/api/component/pyramid/route" will be used.

    useTus?: boolean

    Flag to indicate whether to use the TUS protocol for uploading files in chunks.

    true
    withCredentials?: boolean

    Indicates whether to include credentials such as cookies, authentication headers, or TLS client certificates in cross-site Access-Control requests. Setting this property ensures that cookies from another domain are used in the requests. Note that setting this property has no effect on same-origin requests.

    Settings

    Member Visibility

    On This Page

    Properties