Class Referencer

Hierarchy

default
- Referencer

Index

Constructors

constructor

new Referencer(path, maxSize, type, column): Referencer
Parameters
- path: string
- maxSize: number
- type: ReferenceType
- column: WideColumnarColumn
Returns Referencer
Overrides Referencer.constructor
- Defined in lib/WideColumnar/src/Referencer.ts:27

Properties

`Private` #column

#column: WideColumnarColumn

`Private` #path

#path: string

cache

cache: Record<string, {
    file: string;
    index: number;
    referenceFile: string;
}>

Type declaration

file: string
index: number
referenceFile: string

cacheSize

cacheSize: number = -1

files

files: {
    index: number;
    name: string;
    size: number;
    writer: WriteStream;
}[] = []

Type declaration

index: number
name: string
size: number
writer: WriteStream

maxSize

maxSize: number

type

type: ReferenceType

Accessors

path

get path(): string
Returns string
Inherited from Referencer.path
- Defined in lib/global/referencer.ts:50

Methods

`Private` #bulkDeleteReference

#bulkDeleteReference(keys, file): Promise<void>
Parameters
- keys: string[]
- file: string
Returns Promise<void>
Inherited from Referencer.#bulkDeleteReference
- Defined in lib/global/referencer.ts:352

`Private` #createFile

#createFile(): void
Returns void
- Defined in lib/WideColumnar/src/Referencer.ts:133

`Private` #createFile

#createFile(): void
Private
Returns void

Description
create file
Inherited from Referencer.#createFile
- Defined in lib/global/referencer.ts:162

`Private` #currentFile

#currentFile(): {
    index: number;
    name: string;
    size: number;
    writer: WriteStream;
}
Returns {
    index: number;
    name: string;
    size: number;
    writer: WriteStream;
}
- index: number
- name: string
- size: number
- writer: WriteStream
- Defined in lib/WideColumnar/src/Referencer.ts:129

`Private` #currentFile

#currentFile(): {
    name: string;
    size: number;
    writer: WriteStream;
}
Private
Returns {
    name: string;
    size: number;
    writer: WriteStream;
}
current file
- name: string
- size: number
- writer: WriteStream
Description
get current file
Inherited from Referencer.#currentFile
- Defined in lib/global/referencer.ts:148

`Private` #deleteReference

#deleteReference(key, file): Promise<void>
Private
Parameters
- key: string
  
  key to delete
- file: string
  
  file to delete
Returns Promise<void>

Description
delete reference
Inherited from Referencer.#deleteReference
- Defined in lib/global/referencer.ts:230

`Private` #getFileReference

#getFileReference(file): Promise<Record<string, string>>
Parameters
- file: string
  
  file to get reference
Returns Promise<Record<string, string>>

Description
get all references from file
Inherited from Referencer.#getFileReference
- Defined in lib/global/referencer.ts:249

`Private` #getIndex

#getIndex(file): number
Parameters
- file: string
Returns number
- Defined in lib/WideColumnar/src/Referencer.ts:96

`Private` #getReference

#getReference(): Promise<Record<string, {
    file: string;
    index: number;
    referenceFile: string;
}>>
Returns Promise<Record<string, {
    file: string;
    index: number;
    referenceFile: string;
}>>
- Defined in lib/WideColumnar/src/Referencer.ts:62

`Private` #getReference

#getReference(): Promise<Record<string, {
file: string;
referenceFile: string;
}>>
Private
Returns Promise<Record<string, {
file: string;
referenceFile: string;
}>>

Description
get reference from files
Inherited from Referencer.#getReference
- Defined in lib/global/referencer.ts:60

`Private` #saveReference

#saveReference(key, file): void
Parameters
- key: string
- file: string
Returns void
- Defined in lib/WideColumnar/src/Referencer.ts:102

`Private` #saveReference

#saveReference(key, file): Promise<unknown>
Private
Parameters
- key: string
  
  key to save
- file: string
  
  file to save
Returns Promise<unknown>

Description
save reference to file
Inherited from Referencer.#saveReference
- Defined in lib/global/referencer.ts:121

`Private` #syncReference

#syncReference(): Promise<void>
Returns Promise<void>
- Defined in lib/WideColumnar/src/Referencer.ts:40

bulkDeleteReference

bulkDeleteReference(keys): Promise<void>
Parameters
- keys: string[]
Returns Promise<void>
Description
restart the Referencer

Example
```
<Referencer>.restart()
```
Inherited from Referencer.bulkDeleteReference
- Defined in lib/global/referencer.ts:320

bulkSetReference

bulkSetReference(reference): Promise<void>
Parameters
- reference: Record<string, string>
Returns Promise<void>
Inherited from Referencer.bulkSetReference
- Defined in lib/global/referencer.ts:383

clear

clear(): Promise<void>
Returns Promise<void>
Description
clear the Referencer

Example
```
<Referencer>.clear()
```
Inherited from Referencer.clear
- Defined in lib/global/referencer.ts:271

deleteReference

deleteReference(key): Promise<void>
Parameters
- key: string
  
  key to delete
Returns Promise<void>
Description
delete reference

Example
```
<Referencer>.deleteReference("key")
```
Inherited from Referencer.deleteReference
- Defined in lib/global/referencer.ts:207

getReference

getReference(): Promise<Record<string, {
    file: string;
    index: number;
    referenceFile: string;
}>>
Returns Promise<Record<string, {
    file: string;
    index: number;
    referenceFile: string;
}>>
Overrides Referencer.getReference
- Defined in lib/WideColumnar/src/Referencer.ts:146

initialize

initialize(): Promise<void>
Returns Promise<void>
Overrides Referencer.initialize
- Defined in lib/WideColumnar/src/Referencer.ts:33

open

open(): void
Returns void
Description
open the Referencer

Example
```
<Referencer>.open()
```
Inherited from Referencer.open
- Defined in lib/global/referencer.ts:302

restart

restart(): void
Returns void
Inherited from Referencer.restart
- Defined in lib/global/referencer.ts:367

setReference

setReference(key, file): Promise<void>
Parameters
- key: string
- file: string
Returns Promise<void>
Overrides Referencer.setReference
- Defined in lib/WideColumnar/src/Referencer.ts:117

sync

sync(files, table): Promise<void>
Parameters
- files: string[]
- table: default
Returns Promise<void>
Inherited from Referencer.sync
- Defined in lib/global/referencer.ts:394

Generated using TypeDoc