Class: VoterFileBuilder

Defined in: builders/voterfile.ts:16

Constructors

Constructor

new VoterFileBuilder(config, voterStream): VoterFileBuilder;

Defined in: builders/voterfile.ts:21

Parameters

Parameter	Type
config	{ bbox: Envelope; division: DivisionShape; metadata?: string; }
config.bbox	Envelope
config.division	DivisionShape
config.metadata?	string
voterStream	ReadableStream<VoterFeature[]>

Returns

VoterFileBuilder

Constructor

new VoterFileBuilder(config, voterStream): VoterFileBuilder;

Defined in: builders/voterfile.ts:25

Parameters

Parameter	Type
config	{ bbox: Envelope; division?: DivisionShape; metadata?: string; name?: string; }
config.bbox	Envelope
config.division?	DivisionShape
config.metadata?	string
config.name?	string
voterStream	ReadableStream<VoterFeature[]>

Returns

VoterFileBuilder

Accessors

division

Get Signature

get division(): DivisionShape | undefined;

Defined in: builders/voterfile.ts:39

Returns

DivisionShape | undefined

---

envelope

Get Signature

get envelope(): Envelope;

Defined in: builders/voterfile.ts:43

Returns

Envelope

---

name

Get Signature

get name(): string;

Defined in: builders/voterfile.ts:47

Returns

string

Methods

[asyncIterator]()

asyncIterator: AsyncIterableIterator<VoterFeature>;

Defined in: builders/voterfile.ts:85

Returns

AsyncIterableIterator<VoterFeature>

---

to()

to(outfile, options?): Promise<string>;

Defined in: builders/voterfile.ts:98

Parameters

Parameter	Type
outfile	string
options?	{ metadata?: string; onFeature?: (count) => void; }
options.metadata?	string
options.onFeature?	(count) => void

Returns

Promise<string>

---

toArray()

toArray(): Promise<VoterFeature[]>;

Defined in: builders/voterfile.ts:93

Returns

Promise<VoterFeature[]>

---

merge()

static merge(
   builders, 
   bbox, 
   options?): VoterFileBuilder;

Defined in: builders/voterfile.ts:53

Parameters

Parameter	Type
builders	VoterFileBuilder[]
bbox	Envelope
options?	{ filter?: (lon, lat) => boolean; name?: string; }
options.filter?	(lon, lat) => boolean
options.name?	string

Returns

VoterFileBuilder