Class UrlManager

Hierarchy (View Summary)

GirafeSingleton
- UrlManager

Index

Constructors

Properties

Methods

getBaseUrlPath getHash getParam getParams getParamsWithPrefix getRootUrl hasHash initializeSingleton isNullOrUndefinedOrBlank removeParams updateHash updateUrl

Constructors

constructor

new UrlManager(context: IGirafeContext): UrlManager
Parameters
- context: IGirafeContext
Returns UrlManager
Inherited from GirafeSingleton.constructor
- Defined in src/base/GirafeSingleton.ts:7

Properties

`Protected` `Readonly`context

context: IGirafeContext

Methods

getBaseUrlPath

getBaseUrlPath(): string
Return the current url without the url parameters

Returns string
- Defined in src/tools/url/urlmanager.ts:59

getHash

getHash(): string | null
Get the current hash from the url

Returns string | null
- Defined in src/tools/url/urlmanager.ts:86

getParam

getParam(param: string): string | null
Parameters
- param: string
Returns string | null
- Defined in src/tools/url/urlmanager.ts:4

getParams

getParams(...args: string[]): Record<string, string | null>
Read all the arguments from the current url
Parameters
- ...args: string[]
Returns Record<string, string | null>
- Defined in src/tools/url/urlmanager.ts:11

getParamsWithPrefix

getParamsWithPrefix(...prefixList: string[]): Record<string, string | null>
Parameters
- ...prefixList: string[]
Returns Record<string, string | null>
- Defined in src/tools/url/urlmanager.ts:21

getRootUrl

getRootUrl(): string
Return the current root URL

Returns string
- Defined in src/tools/url/urlmanager.ts:49

hasHash

hasHash(searchedHash: string): boolean
Check if the url contains the searched hash
Parameters
- searchedHash: string
Returns boolean
- Defined in src/tools/url/urlmanager.ts:97

initializeSingleton

initializeSingleton(): void
Returns void
Inherited from GirafeSingleton.initializeSingleton
- Defined in src/base/GirafeSingleton.ts:11

isNullOrUndefinedOrBlank

isNullOrUndefinedOrBlank(val: unknown): val is "" | null | undefined
Parameters
- val: unknown
Returns val is "" | null | undefined
Inherited from GirafeSingleton.isNullOrUndefinedOrBlank
- Defined in src/base/GirafeSingleton.ts:18

removeParams

removeParams(...args: string[]): void
Remove the arguments from the current url
Parameters
- ...args: string[]
Returns void
- Defined in src/tools/url/urlmanager.ts:38

updateHash

updateHash(hash: string): void
Update the hash of the url
Parameters
- hash: string
Returns void
- Defined in src/tools/url/urlmanager.ts:77

updateUrl

updateUrl(url: string | URL, data?: unknown): void
Replace the url in the browser
Parameters
- url: string | URL
  url to replace
- Optionaldata: unknown
  optional data to pass to replaceState
Returns void
- Defined in src/tools/url/urlmanager.ts:70