Wondering what’s next for npm?Check out our public roadmap! »

    @advanced-rest-client/arc-definitions
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.1 • Public • Published

    Published on NPM

    Build Status

    Published on webcomponents.org

    arc-definitions

    Request / response headers and status codes definitions database used in Adavanced REST Client and API Console.

    The <arc-definitions> element listens for query events. Other elements can dispatch the query-headers and query-status-codes events that are handled by this element. Events are stopped from propagation. Handled event receives new property on the detail object with the query result.

    Usage

    Dispatching query events

    Querying for headers data

    Each header definition item has the following properties:

    • key - String, The name of the header
    • desc - String, The documentation for the header
    • example - String, Example value of the header
    • autocomplete - Array of String, list of possible/example values for autocomplete functions. This property is not available for response headers.
    {
      "key": "Accept-Charset",
      "desc": "Character sets that are acceptable",
      "example": "Accept-Charset: utf-8",
      "autocomplete": ["utf-8"]
    }

    To query for the headers data dispatch query-headers event:

    const e = new CustomEvent('query-headers', {
      detail: {
        type: 'request', // or "response"
        query: 'Acce'
      },
      bubbles: true,
      cancelable: true
    });
    document.body.dispatchEvent(e);
    console.log(event.defaultPrevented); // true
    const headers = event.detail.headers;  // Array[...]

    or use imperative API:

    const data = document.querySelector('arc-definitions').queryHeaders('A', 'response');
    console.log(data); // list of headers with "A" in the name

    Querying for status code data

    Status code definition item has the following properties:

    • key - Number, Code value
    • desc - String, The documentation for the status code
    • label - String, Status label associated with the code
    {
      "key": 101,
      "label": "Switching Protocols",
      "desc":"This means the requester has asked the server to switch protocols and the server is acknowledging that it will do so"
    }

    To query for the status code definition dispatch query-status-codes event:

    const e = new CustomEvent('query-status-codes', {
      detail: {
        code: 200
      },
      bubbles: true,
      cancelable: true
    });
    document.body.dispatchEvent(e);
    console.log(event.defaultPrevented); // true
    const statusCode = event.detail.statusCode; // {...}

    or use imperative API:

    const status = document.querySelector('arc-definitions').getStatusCode(201);
    console.log(status); // Status code definition for 201

    Installation

    npm install --save @advanced-rest-client/arc-definitions
    

    In an html file

    <html>
      <head>
        <script type="module">
          import '@advanced-rest-client/arc-definitions/arc-definitions.js';
        </script> 
      </head>
      <body>
        <arc-definitions></arc-definitions>
      </body>
    </html>

    In a LitElement

    import { LitElement, html } from 'lit-element';
    import '@advanced-rest-client/arc-definitions/arc-definitions.js';
     
    class SampleElement extends LitElement {
      render() {
        return html`
        <arc-definitions></arc-definitions>
        `;
      }
    }
    customElements.define('sample-element', SampleElement);

    In a Polymer 3 element

    import {PolymerElement, html} from '@polymer/polymer';
    import '@advanced-rest-client/arc-definitions/arc-definitions.js';
     
    class SampleElement extends PolymerElement {
      static get template() {
        return html`
        <arc-definitions></arc-definitions>
        `;
      }
     
      _authChanged(e) {
        console.log(e.detail);
      }
    }
    customElements.define('sample-element', SampleElement);

    Development

    git clone https://github.com/advanced-rest-client/arc-definitions
    cd arc-definitions
    npm install

    Running the demo locally

    npm start

    Running the tests

    npm test

    Install

    npm i @advanced-rest-client/arc-definitions

    DownloadsWeekly Downloads

    571

    Version

    3.1.1

    License

    Apache-2.0

    Unpacked Size

    98.5 kB

    Total Files

    15

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar