filestack-js/src/lib/request/token.ts

Official JavaScript library for Filestack

/*
 * Copyright (c) 2018 by Filestack
 * Some rights reserved.
 *
 * 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.
 */
import { EventEmitter } from 'eventemitter3';

/**
 * Filestack token that allow pause, resume or cancel given upload
 *
 * @export
 * @class FsToken
 * @extends {EventEmitter}
 */
export class FsCancelToken extends EventEmitter {

  /**
   * Cancel request action
   *
   * @param {(string | Error)} [reason]
   * @memberof Token
   */
  public cancel(reason?: string | Error) {
    this.emit('cancel', reason);

    this.removeAllListeners();
  }

}