Правильно расширить класс stream.Transform с помощью TypeScript - PullRequest
Новая
       27

Правильно расширить класс stream.Transform с помощью TypeScript

0 голосов
/ 18 сентября 2018

У меня есть этот код: 

import * as stream from 'stream';    

export class JSONParser extends stream.Transform {

  lastLineData = '';
  objectMode = true;

  constructor() {
    super();

  }

  transform(chunk, encoding, cb) {

    let data = String(chunk);
    if (this.lastLineData) {
      data = this.lastLineData + data;
    }

    let lines = data.split('\n');
    this.lastLineData = lines.splice(lines.length - 1, 1)[0];

    lines.forEach(l => {
      try {
        // l might be an empty string; ignore if so
        l && this.push(JSON.parse(l));
      }
      catch (err) {
        // noop
      }
    });

    cb();

  }

  flush(cb) {
    if (this.lastLineData) {
      try {
        this.push(JSON.parse(this.lastLineData));
      }
      catch (err) {
        // noop
      }
    }
    this.lastLineData = '';
    cb();
  }


}

проблема заключается в том, что типизации TS не распознают (прототип) методы.Я неправильно расширяю класс Transform?

Вот проблема:

enter image description here

Обратите внимание, что это правильно: 

import * as stream from 'stream';

//////////////////////////////////////////////////

export interface IParsedObject {
  [index: string]: any
}

export const createParser = function () {

  let lastLineData = '';

  return new stream.Transform({

    objectMode: true,

    transform(chunk: any, encoding: string, cb: Function) {

      let data = String(chunk);
      if (lastLineData) {
        data = lastLineData + data;
      }

      let lines = data.split('\n');
      lastLineData = lines.splice(lines.length - 1, 1)[0];

      lines.forEach(l => {
        try {
          // l might be an empty string; ignore if so
          l && this.push(JSON.parse(l));
        }
        catch (err) {
          // noop
        }
      });

      cb();

    },

    flush(cb: Function) {
      if (lastLineData) {
        try {
          this.push(JSON.parse(lastLineData));
        }
        catch (err) {
          // noop
        }
      }
      lastLineData = '';
      cb();
    }
  });

};

но этот класс выше, похоже, не работает так же.

Ответы [ 2 ]

0 голосов
/ 19 сентября 2018

На вашем скриншоте вы пытаетесь расширить класс Transform, но вы не реализуете правильный метод, вы должны реализовать transform._transform(chunk, encoding, callback), тогда машинопись автоматически выведет требуемые типы.* * * * * * * * * * * * * * * * * * * * * * * * * * * * *} * * * * * * * * * * * * * * * * * * *}} [Тогда, когда в вашем коде вы выбрали «упрощенный» конструктор Transform, поэтому компилятор не выдает предупреждение.,Конструктор принимает набор параметров, который позволяет вам определять необходимые методы преобразования без явного расширения класса.Эти параметры выбирают соглашение о присвоении имен с префиксом без подчеркивания, но они эквивалентны методам с префиксом подчеркивания при расширении класса.Так как вы использовали правильное имя для метода здесь, типы могли быть выведены.

API Transform требует реализации трех методов, эти методы обрисованы в общих чертах здесь .

Существует два способа реализации потока Transform:

  1. Расширение класса Transform
  2. Использование параметров конструктора Transform.

Обрисованы два метода здесь (включен пример расширения класса в средах до ES6).

При реализации TransformВ потоковом режиме должен быть реализован только один метод:

  1. transform._transform(chunk, encoding, callback)

Два других метода являются необязательными и могут быть реализованы, если для этого используется сценарий использования:

  1. transform._flush(callback)
  2. writable._final(callback)

Я описал документированные методы Transform ниже, выделив некоторые области, которые могутпредставлять интерес.

transform._flush(callback)

Эта функция НЕ ДОЛЖНА бытьвызывается по коду приложения напрямую.Он должен быть реализован дочерними классами и вызываться только внутренними методами класса Readable.

В некоторых случаях для операции преобразования может потребоваться выброс дополнительного бита данных в конце потока.Например, поток сжатия zlib будет хранить количество внутреннего состояния, используемого для оптимального сжатия вывода.Однако, когда поток заканчивается, эти дополнительные данные необходимо сбросить, чтобы сжатые данные были завершены.

Пользовательские реализации преобразования могут реализовать метод transform._flush (). Это будет вызвано, когда больше нет записанных данных, которые должны быть использованы, но до того, как будет отправлено событие 'end', сигнализирующее об окончании считываемого потока.

В реализации transform._flush ()метод readable.push () может вызываться ноль или более раз, в зависимости от ситуации.Функция обратного вызова должна вызываться после завершения операции сброса.

Метод transform._flush () имеет префикс с подчеркиванием, поскольку он является внутренним по отношению к классу, который его определяет, и никогда не должен вызыватьсянепосредственно пользовательскими программами.

transform._transform(chunk, encoding, callback)

Эта функция НЕ ДОЛЖНА вызываться кодом приложения напрямую.Он должен быть реализован дочерними классами и вызываться только внутренними методами класса Readable.

Все реализации потока Transform должны предоставлять метод _transform () для приема ввода и вывода вывода. Реализация transform._transform () обрабатывает записываемые байты, вычисляет вывод, а затем передает этот вывод в читаемую часть, используя метод readable.push ().

Метод transform.push () можетможет вызываться ноль или более раз для генерации вывода из одного входного блока, в зависимости от того, сколько должно быть выведено в результате блока.

Возможно, что никакой выход не генерируется ни из одного данного блока вводаdata.

Функция обратного вызова должна вызываться только тогда, когда текущий фрагмент полностью используется.Первый аргумент, переданный обратному вызову, должен бытьобъект Error, если во время обработки ввода произошла ошибка или null,Если второй аргумент передается обратному вызову, он будет перенаправлен в метод readable.push ().Другими словами, следующие значения эквивалентны: 

transform.prototype._transform = function(data, encoding, callback) {
  this.push(data);
  callback();
};

transform.prototype._transform = function(data, encoding, callback) {
  callback(null, data);
};

Преобразованию метода transform._transform () предшествует символ подчеркивания, поскольку он является внутренним по отношению к классу, который его определяет, иникогда не должен вызываться напрямую пользовательскими программами.

transform._transform () никогда не вызывается параллельно;Потоки реализуют механизм очереди, и для получения следующего фрагмента необходимо вызвать обратный вызов, синхронно или асинхронно.

writable._final(callback)

Метод _final () не должен вызываться напрямую.Он может быть реализован дочерними классами и, если это так, будет вызываться только внутренними методами класса Writable.

Эта необязательная функция будет вызываться до закрытия потока, задерживая событие 'finish' дообратный вызов называется.Это полезно для закрытия ресурсов или записи буферизованных данных до окончания потока.

0 голосов
/ 19 сентября 2018

Хорошо, теперь это похоже на работу, мне пришлось передать параметры конструктора в super(), чтобы он стал super({objectMode:true}), 

export class JSONParser extends stream.Transform {

  lastLineData = '';

  constructor() {
    super({objectMode: true});

  }

  _transform(chunk: any, encoding: string, cb: Function) {

    let data = String(chunk);
    if (this.lastLineData) {
      data = this.lastLineData + data;
    }

    let lines = data.split('\n');
    this.lastLineData = lines.splice(lines.length - 1, 1)[0];

    lines.forEach(l => {
      try {
        // l might be an empty string; ignore if so
        l && this.push(JSON.parse(l));
      }
      catch (err) {
        // noop
      }
    });

    cb();

  }

  flush(cb: Function) {
    if (this.lastLineData) {
      try {
        this.push(JSON.parse(this.lastLineData));
      }
      catch (err) {
        // noop
      }
    }
    this.lastLineData = '';
    cb();
  }

  _flush(cb: Function) {
    if (this.lastLineData) {
      try {
        this.push(JSON.parse(this.lastLineData));
      }
      catch (err) {
        // noop
      }
    }
    this.lastLineData = '';
    cb();
  }

}

. Остается только один вопрос: должен ли я реализовывать _flush() или flush(), я не уверен ... Я реализовал оба на данный момент ...

...