Class FeatureStoreLayerChanges

active

• get active(): boolean

  Whether changes are being tracked or not

  Returns boolean

layer

• get layer(): FeatureStoreLayer

  Returns FeatureStoreLayer

StaticclassName

• get className(): string

  Returns string

constructor

• new FeatureStoreLayerChanges(layer: FeatureStoreLayer): FeatureStoreLayerChanges

  Parameters

  • layer: FeatureStoreLayer

  Returns FeatureStoreLayerChanges

addFeature

• addFeature(feature: Feature): void

  adds an addition to the tracker. prefer use of .track

  Parameters

  • feature: Feature

  Returns void

commitChanges

• commitChanges(
      postCallback: (
          body: Pick<CommitAction, "action" | "feature">[],
      ) => Promise<
          {
              failedActions: { error: string; index: number }[];
              insertedIds: { _id: string }[];
          },
      >,
  ): Promise<void>

  commits the changes to the provided url. url should contain accessTokens and point to a featureStore layers bulk operation endpoint

  Parameters

  • postCallback: (
        body: Pick<CommitAction, "action" | "feature">[],
    ) => Promise<
        {
            failedActions: { error: string; index: number }[];
            insertedIds: { _id: string }[];
        },
    >

  Returns Promise<void>

destroy

• destroy(): void

  Returns void

editFeature

• editFeature(feature: Feature): void

  adds an edit to the tracker. prefer use of .track

  Parameters

  • feature: Feature

  Returns void

getChanges

• getChanges(): FeatureStoreTrackResults

  Returns FeatureStoreTrackResults

hasChanges

• hasChanges(): boolean

  Returns boolean

pauseTracking

• pauseTracking(event: keyof FeatureStoreChangesListeners): void

  pauses the tracking of the given event, but does not reset features

  Parameters

  • event: keyof FeatureStoreChangesListeners

    one of: addfeature, changefeature or removefeature

  Returns void

removeFeature

• removeFeature(feature: Feature): void

  tracks the change of removing a static feature

  Parameters

  • feature: Feature

  Returns void

reset

• reset(): Promise<void>

  resets all changes since the last commit or the beginning of tracking

  Returns Promise<void>

track

• track(): void

  starts tracking changes on the layer starts tracking changes on the feature store layer

  Returns void

unTrack

• unTrack(): void

  stops tracking changes on the feature store layer

  Returns void

changed