semantic-network/lib/interfaces/resourceFetchOptions.d.ts

A utility library for manipulating a list of links that form a semantic interface to a network of resources.

import { AddRequestHeaderStrategy } from './addRequestHeaderStrategy';
import { CheckHeaderStrategy } from './checkHeaderStrategy';
import { TrackResponseStrategy } from './trackResponseStrategy';
export interface ResourceFetchOptions {
    /**
     * When set to true, the next check on the resource ensures that it flushes through the stack
     */
    readonly forceLoad?: boolean;
    /**
     * When set to true, the next check on the resource ensures that it flushes back through the network on the feed only
     * and not the items when {@link includeItems} is true. However, it still adheres to the server cache control. If you want
     * to do a force reload then also set the headers {@see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control}.
     */
    readonly forceLoadFeedOnly?: boolean;
    /**
     * Set of strategies to check where the resource based on its headers requires fetching. Override this the default
     * to change
     */
    checkHeaderStrategies?: CheckHeaderStrategy[];
    /**
     * When set to true, the loader will detect a stale eTag state and then call the provided {@link AddRequestHeaderStrategy}
     *
     * @default false (currently experimental)
     */
    readonly useStaleEtagStrategy?: boolean;
    /**
     * When set to true, the loader will detect any eTags in the headers and provided back on the request in the 'if-none-match' header
     *
     * This functionality allows the server to provide the eTag in the feed and then detection back through to the server
     *
     * @default false (currently experimental)
     * @deprecated use {@link axiosRequestConfigHeadersStrategies}
     */
    readonly defaultStaleEtagAddRequestHeaderStrategy?: AddRequestHeaderStrategy;
    readonly requestHeadersStrategies?: AddRequestHeaderStrategy[];
    /**
     * Switch passed into the {@link trackResponseStrategies} whee in the {@link TrackedRepresentationFactory.defaultResponseStrategies}
     * the response is not stored on the state
     * @default true
     */
    readonly trackResponse?: boolean;
    /**
     * Current uses {@link TrackedRepresentationFactory.defaultResponseStrategies} to add the original response data
     * onto the state object
     */
    readonly trackResponseStrategies?: TrackResponseStrategy[];
}