https://github.com/arc-archive/arc-headers

⛔️ DEPRECATED This component is deprecated. Use `@advanced-rest-client/app` instead.
https://github.com/arc-archive/arc-headers

deprecated obsolete

Last synced: about 1 month ago
JSON representation

⛔️ DEPRECATED This component is deprecated. Use `@advanced-rest-client/app` instead.

• Host: GitHub
• URL: https://github.com/arc-archive/arc-headers
• Owner: arc-archive
• License: other
• Created: 2020-10-04T00:14:33.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-09-09T21:17:27.000Z (over 2 years ago)
• Last Synced: 2024-04-14T10:58:45.219Z (9 months ago)
• Topics: deprecated, obsolete
• Language: JavaScript
• Homepage:
• Size: 554 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Deprecated

This component is deprecated. Use `@advanced-rest-client/app` instead.

----

A module that contains UI and logic for handle HTTP headers in an HTTP request and request editors.

[![Published on NPM](https://img.shields.io/npm/v/@advanced-rest-client/arc-headers.svg)](https://www.npmjs.com/package/@advanced-rest-client/arc-headers)

[![Tests and publishing](https://github.com/advanced-rest-client/arc-headers/actions/workflows/deployment.yml/badge.svg)](https://github.com/advanced-rest-client/arc-headers/actions/workflows/deployment.yml)

## Usage

### Installation

```sh

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

```

### HeadersParser module

A helper class to process headers as string, array, object, or a Headers object.

```js

import { HeadersParser } from '@advanced-rest-client/arc-headers';

const errorMessage = HeadersParser.getError('Whitespace Name: x-true');

```

### HeadersEditorElement

An HTTP headers editor UI.

```html

{

  editor.model = [{ name: 'content-type', value: 'application/json', enabled: true }];

  // or

  editor.value = 'content-type: application/json';

  editor.onchange = (e) => { console.log(e.target.value, e.target.model); }

}

```

Try not to use both `value` and `model` when setting the value of the editor. The last set value wins and overrides the other one.

If your application uses the headers view model (to add support for enable/disable header state) then only use model. The editor will

produce value when anything after setting up the model change. This is done to minimize number of computations when working with the editor.

The component listens to content type change event (defined in [arc-events](https://github.com/advanced-rest-client/arc-events) as RequestEvents.State.contentTypeChange) and updated the current value when the event is handled.

### HeadersListElement

An list of formatted HTTP headers.

```html

{

  editor.headers = 'content-type: x-test\nLink: <https://api.github.com/organizations/19393150/repos?page=6>, rel="next";';

}

```

## Development

```sh

git clone https://github.com/advanced-rest-client/arc-headers

cd arc-headers

npm install

```

### Running the demo locally

```sh

npm start

```

### Running the tests

```sh

npm test

```