posthtml-url-parameters

    1.0.6 • Public • Published

    URL Parameters

    Add parameters to URLs

    Version License Build Downloads

    About

    This is a PostHTML plugin that allows you to add parameters to URLs.

    Install

    $ npm i posthtml posthtml-url-parameters
    

    Usage

    const posthtml = require('posthtml')
    const urlParams = require('posthtml-url-parameters')
    
    posthtml([
        urlParams({
          parameters: { foo: 'bar', baz: 'qux' }
        })
      ])
      .process('<a href="https://example.com">Test</div>')
      .then(result => console.log(result.html)))
    
      // <a href="https://example.com?baz=qux&foo=bar">Test</div>

    Configuration

    parameters

    Default: undefined

    Object containing parameter name (key) and its value.

    Example:

    require('posthtml-url-parameters')({
      parameters: {
        utm_source: 'Campaign',
        '1stDraft': true
      }
    })

    tags

    Default: [a]

    Array of tag names to process. Only URLs inside href="" attributes of tags in this array will be processed.

    Example:

    require('posthtml-url-parameters')({
      tags: ['a', 'link'],
      // ...
    })

    qs

    Default: undefined

    Options to pass to query-string - see available options here.

    For example, you can disable encoding:

    const posthtml = require('posthtml')
    const urlParams = require('posthtml-url-parameters')
    
    posthtml([
        urlParams({
          parameters: { foo: '@Bar@' },
          qs: {
            encode: false
          }
        })
      ])
      .process('<a href="https://example.com">Test</div>')
      .then(result => console.log(result.html)))
    
      // <a href="https://example.com?foo=@Bar@">Test</div>

    Install

    npm i posthtml-url-parameters

    DownloadsWeekly Downloads

    2,568

    Version

    1.0.6

    License

    MIT

    Unpacked Size

    10.3 kB

    Total Files

    26

    Last publish

    Collaborators

    • cossssmin