README

@tokenizer/range

Adapter to designed to convert strtok3 tokenizer to RFC-7233 range requests.

It is an abstract module which implements the range request mechanism which can be used by different implementations, like:

@tokenizer/http: An HTTP(S) client
@tokenizer/s3: An Amazon S3 client

Compatibility

This module can be used both in the browser and in Node.js.

Installation

Install using npm:

npm install @tokenizer/range

or using yarn:

yarn add @tokenizer/range

Usage

(async () => {
  const config = {
    avoidHeadRequests: false
  };

  let rangeRequestClient; // HTTP implementation, or HTTP cloud access adaptor

  const tokenizer = await rangeRequestTokenizer.tokenizer(rangeRequestClient, config);
})();

Range-request-client

The IRangeRequestClient defines the interface to map, presumably an HTTP client, to the range request mechanism.

/**
 * Implementation of the range-request-client
 */
export interface IRangeRequestClient {

  /**
   * Head request to determine the size and MIME-type of the file
   * @return HEAD-request information
   */
  getHeadInfo?(): Promise<IHeadRequestInfo>;

  /**
   *
   * @param method - HTTP method
   * @param range - Array of 2 numbers: The range-start and range-end. An integer indicating the beginning and the end of range request in bytes.
   * @return Range request response
   */
  getResponse(method: string, range?: [number, number]): Promise<IRangeRequestResponse>;
}

For further details of the interface see: lib/types.ts

Example implementations of the IRangeRequestClient interface:

Licence

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. git pull THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!