@pollyjs/adapter

Extendable base adapter class used by @pollyjs

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@pollyjs/adapter
6.0.410 months ago4 years agoMinified + gzip package size for @pollyjs/adapter in KB

Readme

Polly.JS

Record, Replay, and Stub HTTP Interactions


Build Status npm version license
The @pollyjs/adapter package provides an extendable base adapter class that contains core logic dependent on by the Fetch & XHR adapters.

Installation

Note that you must have node (and npm) installed.
npm install @pollyjs/adapter -D

If you want to install it with yarn:
yarn add @pollyjs/adapter -D

Documentation

Check out the Custom Adapter documentation for more details.

Usage

import Adapter from '@pollyjs/adapter';

class CustomAdapter extends Adapter {
  static get id() {
    return 'custom';
  }

  onConnect() {
    /* Do something when the adapter is connect to */
  }

  onDisconnect() {
    /* Do something when the adapter is disconnected from */
  }
}

For better usage examples, please refer to the source code for the Fetch & XHR adapters.

License

Copyright (c) 2018 Netflix, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.