Skip to main content

@terascope/elasticsearch-asset-apis / elasticsearch-reader-api/algorithms/id-utils/chunkers/key-chunkers / KeyChunker

Class: KeyChunker

Defined in: elasticsearch-reader-api/algorithms/id-utils/chunkers/key-chunkers.ts:36

Extends​

  • BaseChunker

Constructors​

Constructor​

new KeyChunker(chars): KeyChunker

Defined in: elasticsearch-reader-api/algorithms/id-utils/chunkers/key-chunkers.ts:8

Parameters​

ParameterType
charsreadonly string[] | string[]

Returns​

KeyChunker

Inherited from​

BaseChunker.constructor

Properties​

PropertyTypeDefault valueInherited fromDefined in
indexnumber0BaseChunker.indexelasticsearch-reader-api/algorithms/id-utils/chunkers/key-chunkers.ts:3
isDonebooleanfalseBaseChunker.isDoneelasticsearch-reader-api/algorithms/id-utils/chunkers/key-chunkers.ts:2
keysstring[]undefinedBaseChunker.keyselasticsearch-reader-api/algorithms/id-utils/chunkers/key-chunkers.ts:6
tooknumber0BaseChunker.tookelasticsearch-reader-api/algorithms/id-utils/chunkers/key-chunkers.ts:4
totalnumberundefinedBaseChunker.totalelasticsearch-reader-api/algorithms/id-utils/chunkers/key-chunkers.ts:5

Methods​

chunk()​

chunk(numOfChars): string

Defined in: elasticsearch-reader-api/algorithms/id-utils/chunkers/key-chunkers.ts:37

Parameters​

ParameterType
numOfCharsnumber

Returns​

string

Overrides​

BaseChunker.chunk


commit()​

commit(): void

Defined in: elasticsearch-reader-api/algorithms/id-utils/chunkers/key-chunkers.ts:25

Returns​

void

Inherited from​

BaseChunker.commit


split()​

split(numOfChars): object

Defined in: elasticsearch-reader-api/algorithms/id-utils/chunkers/key-chunkers.ts:15

Parameters​

ParameterType
numOfCharsnumber

Returns​

object

range​

range: string

took​

took: number

Inherited from​

BaseChunker.split