Options
All
  • Public
  • Public/Protected
  • All
Menu

@feature-hub/history-service

Package Version Website API

A history facade guaranteeing safe access for multiple consumers.

Installation

Using Yarn

yarn add @feature-hub/history-service

Using NPM

npm install @feature-hub/history-service

Copyright (c) 2018-2019 SinnerSchrader Deutschland GmbH. Released under the terms of the MIT License.

Index

Type aliases

RootLocation

RootLocation: Location<ConsumerHistoryStates>

RootLocationDescriptorObject

RootLocationDescriptorObject: LocationDescriptorObject<ConsumerHistoryStates>

Functions

addConsumerPath

  • addConsumerPath(encodedConsumerPaths: string | null, historyKey: string, path: string): string

createRootLocationForOtherConsumer

  • createRootLocationForOtherConsumer(currentRootLocation: RootLocationDescriptorObject, consumerLocation: LocationDescriptorObject, historyKey: string, consumerPathsQueryParamName: string): LocationDescriptorObject

createRootLocationForPrimaryConsumer

  • createRootLocationForPrimaryConsumer(currentRootLocation: RootLocationDescriptorObject, primaryConsumerLocation: LocationDescriptorObject, consumerPathsQueryParamName: string): LocationDescriptorObject

createRootLocationTransformer

createSearchParams

  • createSearchParams(location: LocationDescriptorObject): URLSearchParams

defineHistoryService

getConsumerPath

  • getConsumerPath(encodedConsumerPaths: string, historyKey: string): string

getPrimaryConsumerHistoryKey

serializeSearchParams

  • serializeSearchParams(searchParams: URLSearchParams): string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc