Options
All
  • Public
  • Public/Protected
  • All
Menu

Module url

Index

Interfaces

Type aliases

Functions

Type aliases

Query

Query: {}

Query

Type declaration

  • [key: string]: any

Functions

creatShortURL

  • creatShortURL(longURL: string): string

  • 通过长链接创建短链接，可通过短链接访问长链接地址。长链接域名仅支持子域名及白名单中的域名。

    example
    
import * as url from 'url'

const shortURL=url.creatShortURL("https://xxx.com")

    Parameters

    • longURL: string

      (string):url string

    Returns string

    shortURL string

deleteShortURL

  • deleteShortURL(longURL: string): void

  • 删除长链接对应的短链接

    example
    
import *as url from 'url'
deleteShortURL("https://xxx.com")

    Parameters

    • longURL: string

    Returns void

join

  • join(base: string | URL, ...paths: string[]): string

  • join url path

    example
    
import * as url from 'url'

const base = url.parse('https://xxx.com')
url.join(base, '/hello')

    Parameters

    • base: string | URL

      (string | URL): url string or URL

    • Rest ...paths: string[]

      (string | URL): relative paths

    Returns string

    joined raw url

parse

  • parse(raw: string): URL

  • parse url string to URL

    example
    
import * as url from 'url';

url.parse('https://xxx.com/example?x=1#y=2')

    Parameters

    • raw: string

      (string): url string

    Returns URL

    parsed URL

parseQuery

  • parseQuery(raw: string): Query

  • parse query string

    example
    
import * as url from 'url'

const q = url.parseQuery('x=2&y=3')

    Parameters

    • raw: string

      (string): query string

    Returns Query

    parsed Query

queryShortURL

  • queryShortURL(longURL: string): string

  • 查询长链接是否存在对应短链接，仅支持子域名及白名单中的域名。

    example
    
import * as url from 'url'
const shortURL=url.queryShortURL("https://xxx.com")

    Parameters

    • longURL: string

      (string):url string

    Returns string

    shortURL string

stringifyQuery

  • stringifyQuery(query: Query): string

  • stringlify query to string

    example
    
import * as url from 'url'

const q = url.parseQuery('x=2&y=3')
url.stringifyQuery(q) === 'x=2&y=3'

    Parameters

    Returns string

    query string