Class SyncTokens

Package version

Sync token tracker (allows for real-time consistency, even in the face of caching and load balancing within App Configuration).

(protocol and format described here) https://github.com/Azure/AppConfiguration/blob/master/docs/REST/consistency.md

internal

Hierarchy

SyncTokens

Index

Methods

Methods

addSyncTokenFromHeaderValue

addSyncTokenFromHeaderValue(syncTokenHeaderValue: string | undefined): void

- Defined in mnt/vss/_work/1/s/sdk/appconfiguration/app-configuration/src/internal/synctokenpolicy.ts:76
Takes the value from the header named after the constant SyncTokenHeaderName and adds it to our list of accumulated sync tokens.

If given an empty value (or undefined) it clears the current list of sync tokens. (indicates the service has properly absorbed values into the cluster).

Parameters
- syncTokenHeaderValue: string | undefined
  
  The full value of the sync token header.
Returns void

getSyncTokenHeaderValue

getSyncTokenHeaderValue(): string | undefined

- Defined in mnt/vss/_work/1/s/sdk/appconfiguration/app-configuration/src/internal/synctokenpolicy.ts:99
Gets a properly formatted SyncToken header value.

Returns string | undefined

Generated using TypeDoc