import Tape from '@async-abstraction/tape/src/Tape.js'

public class | source

Tape

Class that wraps a callable with a tape. Do not use directly. Use fromCallable instead.

Constructor Summary

Public Constructor
public	constructor(callable: Function) The constructor.

Public Members
public	buffer: Array Buffer used to implement Tape#unread.
public	callable: Function The callable yielding values to put on the tape.
public	eof: any The eof symbol.

Public Methods
public	[Symbol.asyncIterator](): AsyncIterator Returns an async iterator on the tokens of the tape.
public	[Symbol.iterator]() Explicitely throws when trying to access iterator symbol.
public	async read(): Promise Returns the next token on the tape or Tape#eof if the tape has been exhausted.
public	async skip() Skips the next token on the tape.
public	async skipMany(n: number) Skip the next `n` tokens on the tape.
public	unread(token: any) Puts a token back on the tape.

The constructor. Stores the callable that yields values to put on the tape.

Name	Type	Attribute	Description
callable	Function		The callable to use.

Buffer used to implement Tape#unread.

The callable yielding values to put on the tape.

The eof symbol.

Returns an async iterator on the tokens of the tape.

AsyncIterator

Iterator on the tokens of the tape.

fromString('abc');
for await ( const token of tape ) console.log(token) ;

Explicitely throws when trying to access iterator symbol.

Always.

Returns the next token on the tape or Tape#eof if the tape has been exhausted.

The next token on the tape or Tape#eof.

Skips the next token on the tape.

Skip the next n tokens on the tape.

Name	Type	Attribute	Description
n	number		The number of tokens to skip.

Puts a token back on the tape. If Tape#read is used just after, this token will be returned.

Name	Type	Attribute	Description
token	any		The token to put back on the tape.