@leadershape/etag v1.0.6

etag

This module is written in Typescript to generate a simple ETag for HTTP responses as defined in RFC 7232 #Section 2.3.

Installation

$ npm install @leadershape/etag

Usage

1) Import

- Using TypeScript

import etag from '@leadershape/etag'

- Using Javascript

var etag = require('@leadershape/etag').default

2) Generate and set ETag header field

// Generate ETag
res.setHeader('ETag', etag(body))

API

/**
 * Generate an ETag
 * 
 * @param entity {string|Buffer}
 * @param weak {boolean}
 */
function etag(entity: string | Buffer, weak: boolean = false): string

Testing

$ npm test

License

MIT