@types/xmpp__uri v0.13.3

Installation

npm install --save @types/xmpp__uri

Summary

This package contains type definitions for @xmpp/uri (https://github.com/xmppjs/xmpp.js/tree/main/packages/uri).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/xmpp__uri.

index.d.ts

// Type definitions for @xmpp/uri 0.13
// Project: https://github.com/xmppjs/xmpp.js/tree/main/packages/uri
// Definitions by: BendingBender <https://github.com/BendingBender>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="node" />
import { JID } from '@xmpp/jid';
import { ParsedUrlQuery } from 'querystring';

/**
 * Parse XMPP URIs.
 *
 * @example
 * import * as URI from '@xmpp/uri';
 *
 * URI.parse('xmpp://guest@example.com/support@example.com/truc?message;subject=Hello%20World')
 *
 * // =>
 * // {
 * //   authority: jid('guest@example.com'), // see https://github.com/xmppjs/xmpp.js/tree/main/packages/jid
 * //   path: jid('support@example.com/truc'), // see https://github.com/xmppjs/xmpp.js/tree/main/packages/jid
 * //   query: {
 * //     type: 'message',
 * //     params: {
 * //       subject: 'Hello World',
 * //     },
 * //   },
 * // }
 */
export function parse(str: string): XMPPURI;

export interface XMPPURI {
    path: JID;
    authority?: JID;
    query?: XMPPURIQuery;
}

export interface XMPPURIQuery {
    type: string;
    params: ParsedUrlQuery;
}

Additional Details

• Last updated: Tue, 30 Nov 2021 17:31:54 GMT
• Dependencies: @types/xmpp__jid, @types/node
• Global values: none

Credits

These definitions were written by BendingBender.