如何在Node.Js中从字符串创建流?

时间:2012-10-06 01:50:32

标签: javascript string node.js stream inputstream

我正在使用一个库ya-csv,它希望文件或流作为输入,但我有一个字符串。

如何将该字符串转换为Node中的流?

12 个答案:

答案 0 :(得分:153)

由于@substack已在#node中更正了我,因此Node v10中的新streams API使这更容易:

const Readable = require('stream').Readable;
const s = new Readable();
s._read = () => {}; // redundant? see update below
s.push('your text here');
s.push(null);

...之后您可以自由地pipe或以其他方式将其传递给您的目标消费者。

它不像resumer单行一样干净,但确实避免了额外的依赖。

更新:在v0.10.26到v9.2.1到目前为止,直接从REPL提示符调用push会因{1}}异常而崩溃设置not implemented。它不会在函数或脚本中崩溃。如果不一致会让你感到紧张,请加入_read

答案 1 :(得分:98)

不要使用Jo Liss的消费者答案。它可以在大多数情况下工作,但在我的情况下,它失去了我4或5小时的错误发现。第三方模块不需要这样做。

新答案

var Readable = require('stream').Readable

var s = new Readable
s.push('beep')    // the string you want
s.push(null)      // indicates end-of-file basically - the end of the stream

这应该是完全兼容的可读流。 See here了解有关如何正确使用流的更多信息。

OLD ANSWER : 只需使用本机PassThrough流:

var stream = require("stream")
var a = new stream.PassThrough()
a.write("your string")
a.end()

a.pipe(process.stdout) // piping will work as normal
/*stream.on('data', function(x) {
   // using the 'data' event works too
   console.log('data '+x)
})*/
/*setTimeout(function() {
   // you can even pipe after the scheduler has had time to do other things
   a.pipe(process.stdout) 
},100)*/

a.on('end', function() {
    console.log('ended') // the end event will be called properly
})

请注意'关闭'不发出事件(流接口不需要)。

答案 2 :(得分:43)

从节点10.17开始,stream.Readable具有from方法,可以轻松地从任何可迭代(包括数组文字)创建流:

const { Readable } = require("stream")

const readable = Readable.from(["input string"])

readable.on("data", (chunk) => {
  console.log(chunk) // will be called once with `"input string"`
})

请注意,至少在10.17和12.3之间,字符串本身是可迭代的,因此Readable.from("input string")可以工作,但每个字符发出一个事件。 Readable.from(["input string"])将为数组中的每个项目发出一个事件(在本例中为一个项目)。

还请注意,在以后的节点中(可能是12.3,因为文档中说函数已被更改),因此不再需要将字符串包装在数组中。

https://nodejs.org/api/stream.html#stream_stream_readable_from_iterable_options

答案 3 :(得分:28)

只需创建stream模块的新实例,然后根据需要对其进行自定义:

var Stream = require('stream');
var stream = new Stream();

stream.pipe = function(dest) {
  dest.write('your string');
  return dest;
};

stream.pipe(process.stdout); // in this case the terminal, change to ya-csv

var Stream = require('stream');
var stream = new Stream();

stream.on('data', function(data) {
  process.stdout.write(data); // change process.stdout to ya-csv
});

stream.emit('data', 'this is my string');

答案 4 :(得分:12)

编辑: Garth's answer可能更好。

我的旧答案文字保留在下面。


要将字符串转换为流,您可以使用暂停的through流:

through().pause().queue('your string').end()

示例:

var through = require('through')

// Create a paused stream and buffer some data into it:
var stream = through().pause().queue('your string').end()

// Pass stream around:
callback(null, stream)

// Now that a consumer has attached, remember to resume the stream:
stream.resume()

答案 5 :(得分:10)

有一个模块:https://www.npmjs.com/package/string-to-stream

var str = require('string-to-stream')
str('hi there').pipe(process.stdout) // => 'hi there' 

答案 6 :(得分:6)

在咖啡脚本中:

class StringStream extends Readable
  constructor: (@str) ->
    super()

  _read: (size) ->
    @push @str
    @push null

使用它:

new StringStream('text here').pipe(stream1).pipe(stream2)

答案 7 :(得分:5)

另一个解决方案是将read函数传递给Readable的构造函数(cf doc stream readeable options

var s = new Readable({read(size) {
    this.push("your string here")
    this.push(null)
  }});

你可以在使用s.pipe后例证

答案 8 :(得分:4)

我厌倦了每六个月重新学习一次,所以我刚刚发布了一个npm模块来抽象出实现细节:

https://www.npmjs.com/package/streamify-string

这是该模块的核心:

const Readable = require('stream').Readable;
const util     = require('util');

function Streamify(str, options) {

  if (! (this instanceof Streamify)) {
    return new Streamify(str, options);
  }

  Readable.call(this, options);
  this.str = str;
}

util.inherits(Streamify, Readable);

Streamify.prototype._read = function (size) {

  var chunk = this.str.slice(0, size);

  if (chunk) {
    this.str = this.str.slice(size);
    this.push(chunk);
  }

  else {
    this.push(null);
  }

};

module.exports = Streamify;

str是必须在调用时传递给构造函数的string,并将作为数据流输出。 options是可以按the documentation传递给流的典型选项。

根据Travis CI,它应该与大多数版本的节点兼容。

答案 9 :(得分:1)

JavaScript是鸭子型的,所以如果你只是复制a readable stream's API,它就会正常工作。实际上,您可能无法实现大多数这些方法,或者只是将它们保留为存根;您需要实现的只是库使用的内容。您也可以使用Node的预构建EventEmitter class来处理事件,因此您不必自己实现addListener等。

以下是在CoffeeScript中实现它的方法:

class StringStream extends require('events').EventEmitter
  constructor: (@string) -> super()

  readable: true
  writable: false

  setEncoding: -> throw 'not implemented'
  pause: ->    # nothing to do
  resume: ->   # nothing to do
  destroy: ->  # nothing to do
  pipe: -> throw 'not implemented'

  send: ->
    @emit 'data', @string
    @emit 'end'

然后你可以像这样使用它:

stream = new StringStream someString
doSomethingWith stream
stream.send()

答案 10 :(得分:0)

在TypeScript中提供了一个整洁的解决方案:

import { Readable } from 'stream'

class ReadableString extends Readable {
    private sent = false

    constructor(
        private str: string
    ) {
        super();
    }

    _read() {
        if (!this.sent) {
            this.push(Buffer.from(this.str));
            this.sent = true
        }
        else {
            this.push(null)
        }
    }
}

const stringStream = new ReadableString('string to be streamed...')

答案 11 :(得分:0)

在 NodeJS 中,您可以通过以下几种方式创建可读流:

解决方案 1

您可以使用 fs 模块来完成。函数 fs.createReadStream() 允许您打开一个可读流,您所要做的就是传递文件的路径以开始流式传输。

const fs = require('fs');

const readable_stream = fs.createReadStream('file_path');

解决方案 2

如果你不想创建文件,你可以创建一个内存流并用它做一些事情(例如,将它上传到某个地方)。您可以使用 stream 模块执行此操作。您可以从 Readable 模块导入 stream 并创建可读流。在创建对象时,您还可以实现 read() 方法,用于从内部缓冲区读取数据。如果没有可供读取的数据,则返回 null。可选的 size 参数指定要读取的特定字节数。如果未指定 size 参数,则将返回内部缓冲区中包含的所有数据。

const Readable = require('stream').Readable;

const readable_stream = new Readable({
  ​read(size) {
   ​// ...
​  }
});

解决方案 3

当您通过网络获取某些内容时,可以像流一样获取(例如,您正在从某个 API 获取 PDF 文档)。

const axios = require('axios');

const readable_stream = await axios({
  method: 'get',
  url: "pdf_resource_url",
  responseType: 'stream'
}).data;

解决方案 4

第三方包可以支持创建流作为功能。这是 aws-sdk 包的一种方式,通常用于将文件上传到 S3

const file = await s3.getObject(params).createReadStream();