@types/har-format

What is @types/har-format?

@types/har-format provides TypeScript type definitions for the HTTP Archive (HAR) format. This package allows developers to work with HAR files in a type-safe manner, ensuring that the structure and data types of HAR files are correctly handled in TypeScript projects.

What are @types/har-format's main functionalities?

Define HAR Log

This feature allows you to define a HAR log object with the necessary properties such as version, creator, and entries. The type definitions ensure that the structure adheres to the HAR specification.

const harLog: harFormat.Log = {
  version: '1.2',
  creator: {
    name: 'Example Browser',
    version: '1.0'
  },
  entries: []
};

Define HAR Entry

This feature allows you to define a HAR entry object, which includes details about an HTTP request and response. The type definitions ensure that all required fields are present and correctly typed.

const harEntry: harFormat.Entry = {
  startedDateTime: new Date().toISOString(),
  time: 100,
  request: {
    method: 'GET',
    url: 'https://example.com',
    httpVersion: 'HTTP/1.1',
    headers: [],
    queryString: [],
    cookies: [],
    headersSize: -1,
    bodySize: -1
  },
  response: {
    status: 200,
    statusText: 'OK',
    httpVersion: 'HTTP/1.1',
    headers: [],
    cookies: [],
    content: {
      size: 0,
      mimeType: 'text/html'
    },
    redirectURL: '',
    headersSize: -1,
    bodySize: -1
  },
  cache: {},
  timings: {
    send: 0,
    wait: 50,
    receive: 50
  }
};

Define HAR Creator

This feature allows you to define the creator of the HAR file, including the name and version of the tool or browser that generated the HAR file. The type definitions ensure that the creator object adheres to the HAR specification.

const harCreator: harFormat.Creator = {
  name: 'Example Browser',
  version: '1.0'
};

Other packages similar to @types/har-format

har-validator

har-validator is a package that provides a set of schemas to validate HAR files. It ensures that the HAR files conform to the HAR specification. Unlike @types/har-format, which provides TypeScript type definitions, har-validator focuses on validation of HAR data.

har-schema

har-schema provides JSON schemas for the HAR format. It is used to validate HAR files against the official HAR specification. While @types/har-format provides TypeScript type definitions, har-schema provides JSON schemas for validation purposes.

har

har is a package that provides utilities for working with HAR files, including parsing and stringifying HAR data. It offers more functionality compared to @types/har-format, which is limited to providing type definitions.

README

Installation

npm install --save @types/har-format

Summary

This package contains type definitions for har-format (https://w3c.github.io/web-performance/specs/HAR/Overview.html).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/har-format.

Additional Details

• Last updated: Sun, 29 Sep 2024 23:07:21 GMT
• Dependencies: none

Credits

These definitions were written by Michael Mrowetz, and Marcell Toth.