reader

Home / reader

reader

Type Aliases

Reader

type Reader: {
  input: string;
  offset: number;
};

Type declaration

Name	Type	Defined in
input	string	reader.ts:2
offset	number	reader.ts:3

Defined in

reader.ts:1

---

t

type t: Reader;

Defined in

reader.ts:6

Functions

advanced()

function advanced(reader, advance): Reader

Parameters

Parameter	Type
reader	Reader
advance	number

Returns

Reader

Defined in

reader.ts:22

---

end()

function end(reader): boolean

Parameters

Parameter	Type
reader	Reader

Returns

boolean

true if end of input has been reached, false otherwise.

Defined in

reader.ts:58

---

length()

function length(reader): number

Parameters

Parameter	Type
reader	Reader

Returns

number

length of remaining input.

Defined in

reader.ts:49

---

mutable()

function mutable(reader): {
  input: string;
  offset: number;
}

Parameters

Parameter	Type
reader	Reader

Returns

{
  input: string;
  offset: number;
}

cloned reader as mutable object.

Name	Type	Defined in
input	string	reader.ts:18
offset	number	reader.ts:18

Defined in

reader.ts:18

---

of()

function of(input, offset): Reader

Parameters

Parameter	Type	Default value
input	string	undefined
offset	number	0

Returns

Reader

reader from input string and optional offset (defaults to 0).

Defined in

reader.ts:11

---

offsetOf()

function offsetOf(
   reader, 
   value, 
   position): number

Parameters

Parameter	Type	Default value
reader	Reader	undefined
value	string	undefined
position	number	0

Returns

number

-1 if not found, otherwise offset of value.

Defined in

reader.ts:39

---

peek()

function peek(reader, offset): undefined | string

Parameters

Parameter	Type	Default value
reader	Reader	undefined
offset	number	0

Returns

undefined | string

character at offset from current input position, undefined if out of bound.

Defined in

reader.ts:29

---

rest()

function rest(reader): string

Parameters

Parameter	Type
reader	Reader

Returns

string

rest of input.

Defined in

reader.ts:44

---

slice()

function slice(
   reader, 
   start, 
   end): string

Parameters

Parameter	Type
reader	Reader
start	number
end	number

Returns

string

Defined in

reader.ts:53

---

startsWith()

function startsWith(
   reader, 
   prefix, 
   position): boolean

Parameters

Parameter	Type	Default value
reader	Reader	undefined
prefix	string	undefined
position	number	0

Returns

boolean

true if input starts with provided prefix, false otherwise.

Defined in

reader.ts:34