Class default

Index

Constructors

Properties

options parseQuery

Methods

encodeURL isExcluded parse parseUrl resolveQueryUrl

Constructors

constructor

new default(opt?: Partial<SafelinkOptions>): default
Parameters
- Optionalopt: Partial<SafelinkOptions>
Returns default
- Defined in safelink.ts:22

Properties

options

options: Required<SafelinkOptions> = ...

parseQuery

parseQuery: (query: string, url: string) => parseQueryResult = _parseQuery

Type declaration

- (query: string, url: string): parseQueryResult
- Parse Query URL and Hash
  Parameters
  - query: string
    query key, null = return all objects
  - url: string
    target query, ex: location.href or location.search
  Returns parseQueryResult

Methods

encodeURL

encodeURL(href: string): string
anonymize url directly
Parameters
- href: string
Returns string
- Defined in safelink.ts:180

isExcluded

isExcluded(url: string | URL): boolean
is url excluded
Parameters
- url: string | URL
Returns boolean
- Defined in safelink.ts:34

parse

parse(
target: string | Buffer<ArrayBufferLike> | HTMLElement | ReadStream,
): Promise<string>
parse html string or element to anonymize urls
Parameters
- target: string | Buffer<ArrayBufferLike> | HTMLElement | ReadStream
Returns Promise<string>
- Defined in safelink.ts:67

parseUrl

parseUrl(url: string): string
parse single url
Parameters
- url: string
Returns string
return redirect url or original url
- when redirect not set, will return encoded URL only
- Defined in safelink.ts:162

resolveQueryUrl

resolveQueryUrl(search?: string): Partial<resolveQueryResult>
Resolve query url to decrypt anonymized urls (page redirector)
Parameters
- Optionalsearch: string
Returns Partial<resolveQueryResult>
- Defined in safelink.ts:193