Skip to main content

class TableNonEmpty<R,C,V,Tp,TpR>

undocumented

Extends: NonEmptyBase<E>

Implements: TableBase.NonEmpty<R,C,V,Tp>

Type parameters​

NameConstraintsDefaultDescription
Rundocumented
Cundocumented
Vundocumented
TpContextImplTypesundocumented
TpRWithRow<Tp, R, C, V>WithRow<Tp, R, C, V>undocumented

Properties​

_NonEmptyType​

undocumented

Definition​

_NonEmptyType: TpR['nonEmpty'];

Overrides​

NonEmptyBase._NonEmptyType

amountRows​

undocumented

Definition​

get amountRows(): number;

Overrides​

VariantTableBase.amountRows

context​

undocumented

Definition​

readonly context: TpR['context'];

Overrides​

TableBase.context

isEmpty​

Returns false since the collection is known to be non-empty.

Definition​

get isEmpty(): false;

Overrides​

NonEmptyBase.isEmptyNonEmpty.isEmpty

rowMap​

undocumented

Definition​

readonly rowMap: TpR['rowMapNonEmpty'];

Overrides​

NonEmpty.rowMap

size​

undocumented

Definition​

readonly size: number;

Overrides​

VariantTableBase.size

Methods​

[Symbol.iterator]​

Returns a fast iterator over the elements of the collection.

addEntries​

undocumented

Definition​

addEntries(entries: StreamSource<readonly [R, C, V]>): TpR['nonEmpty'];

Parameters​

NameTypeDescription
entriesStreamSource<readonly [R, C, V]>

Overrides​

NonEmpty.addEntries

addEntry​

undocumented

Definition​

addEntry(entry: readonly [R, C, V]): TpR['nonEmpty'];

Parameters​

NameTypeDescription
entryreadonly [R, C, V]

Overrides​

TableBase.addEntry

asNormal​

undocumented

Definition​

asNormal(): any;

Overrides​

NonEmptyBase.asNormal, NonEmpty.asNormal

assumeNonEmpty​

undocumented

Definition​

assumeNonEmpty(): any;

Overrides​

NonEmptyBase.assumeNonEmpty, NonEmpty.assumeNonEmpty

copy​

undocumented

Definition​

copy(rowMap: TpR['rowMapNonEmpty'], size: number): TpR['nonEmpty'];

Parameters​

NameTypeDescription
rowMapTpR['rowMapNonEmpty']
sizenumber

copyE​

undocumented

Definition​

copyE(rowMap: TpR['rowMap'], size: number): TpR['normal'];

Parameters​

NameTypeDescription
rowMapTpR['rowMap']
sizenumber

filter​

undocumented

Definition​

filter(pred: (entry: [R, C, V], index: number, halt: () => void) => boolean, options?: {
    negate?: boolean;
  }): TpR['normal'];

Parameters​

NameTypeDescription
pred(entry: [R, C, V], index: number, halt: () => void) => boolean
options{
    negate?: boolean;
  }

Overrides​

VariantTableBase.filter

filterRows​

undocumented

Definition​

filterRows(pred: (entry: readonly [R, TpR['rowNonEmpty']], index: number, halt: () => void) => boolean, options?: {
    negate?: boolean;
  }): TpR['normal'];

Parameters​

NameTypeDescription
pred(entry: readonly [R, TpR['rowNonEmpty']], index: number, halt: () => void) => boolean
options{
    negate?: boolean;
  }

Overrides​

VariantTableBase.filterRows

forEach​

undocumented

Definition​

forEach(f: (entry: [R, C, V], index: number, halt: () => void) => void, options?: {
    state?: TraverseState;
  }): void;

Parameters​

NameTypeDescription
f(entry: [R, C, V], index: number, halt: () => void) => void
options{
    state?: TraverseState;
  }

Overrides​

VariantTableBase.forEach

get​

undocumented

Definition​

get<UR, UC, O>(row: RelatedTo<R, UR>, column: RelatedTo<C, UC>, otherwise?: OptLazy<O>): V | O;

Type parameters​

NameDescription
UR
UC
O

Parameters​

NameTypeDescription
rowRelatedTo<R, UR>
columnRelatedTo<C, UC>
otherwiseOptLazy<O>

Overrides​

VariantTableBase.get

getRow​

undocumented

Definition​

getRow<UR>(row: RelatedTo<R, UR>): TpR['row'];

Type parameters​

NameDescription
UR

Parameters​

NameTypeDescription
rowRelatedTo<R, UR>

Overrides​

VariantTableBase.getRow

hasRowKey​

undocumented

Definition​

hasRowKey<UR>(row: RelatedTo<R, UR>): boolean;

Type parameters​

NameDescription
UR

Parameters​

NameTypeDescription
rowRelatedTo<R, UR>

Overrides​

VariantTableBase.hasRowKey

hasValueAt​

undocumented

Definition​

hasValueAt<UR, UC>(row: RelatedTo<R, UR>, column: RelatedTo<C, UC>): boolean;

Type parameters​

NameDescription
UR
UC

Parameters​

NameTypeDescription
rowRelatedTo<R, UR>
columnRelatedTo<C, UC>

Overrides​

VariantTableBase.hasValueAt

mapValues​

undocumented

Definition​

mapValues<V2>(mapFun: (value: V, row: R, column: C) => V2): (Tp & Row<R, C, V2>)['nonEmpty'];

Type parameters​

NameDescription
V2

Parameters​

NameTypeDescription
mapFun(value: V, row: R, column: C) => V2

Overrides​

NonEmpty.mapValues

modifyAt​

undocumented

Definition​

modifyAt(row: R, column: C, options: {
    ifNew?: OptLazyOr<V, Token>;
    ifExists?: ((value: V, remove: Token) => V |Token)| V;
  }): TpR['normal'];

Parameters​

NameTypeDescription
rowR
columnC
options{
    ifNew?: OptLazyOr<V, Token>;
    ifExists?: ((value: V, remove: Token) => V |Token)| V;
  }

Overrides​

TableBase.modifyAt

nonEmpty​

Returns true and instructs the compiler to treat the instance as non-empty.

Definition​

nonEmpty(): this is this['_NonEmptyType'];

Overrides​

NonEmptyBase.nonEmpty, NonEmpty.nonEmpty

remove​

undocumented

Definition​

remove<UR, UC>(row: RelatedTo<R, UR>, column: RelatedTo<C, UC>): TpR['normal'];

Type parameters​

NameDescription
UR
UC

Parameters​

NameTypeDescription
rowRelatedTo<R, UR>
columnRelatedTo<C, UC>

Overrides​

VariantTableBase.remove

removeAndGet​

undocumented

Definition​

removeAndGet<UR, UC>(row: RelatedTo<R, UR>, column: RelatedTo<C, UC>): [TpR['normal'], V] | undefined;

Type parameters​

NameDescription
UR
UC

Parameters​

NameTypeDescription
rowRelatedTo<R, UR>
columnRelatedTo<C, UC>

Overrides​

VariantTableBase.removeAndGet

removeEntries​

undocumented

Definition​

removeEntries<UR, UC>(entries: StreamSource<[RelatedTo<R, UR>, RelatedTo<C, UC>]>): TpR['normal'];

Type parameters​

NameDescription
UR
UC

Parameters​

NameTypeDescription
entriesStreamSource<[RelatedTo<R, UR>, RelatedTo<C, UC>]>

Overrides​

VariantTableBase.removeEntries

removeRow​

undocumented

Definition​

removeRow<UR>(row: RelatedTo<R, UR>): TpR['normal'];

Type parameters​

NameDescription
UR

Parameters​

NameTypeDescription
rowRelatedTo<R, UR>

Overrides​

VariantTableBase.removeRow

removeRowAndGet​

undocumented

Definition​

removeRowAndGet<UR>(row: RelatedTo<R, UR>): [TpR['normal'], TpR['rowNonEmpty']] | undefined;

Type parameters​

NameDescription
UR

Parameters​

NameTypeDescription
rowRelatedTo<R, UR>

Overrides​

VariantTableBase.removeRowAndGet

removeRows​

undocumented

Definition​

removeRows<UR>(rows: StreamSource<RelatedTo<R, UR>>): TpR['normal'];

Type parameters​

NameDescription
UR

Parameters​

NameTypeDescription
rowsStreamSource<RelatedTo<R, UR>>

Overrides​

VariantTableBase.removeRows

set​

undocumented

Definition​

set(row: R, column: C, value: V): TpR['nonEmpty'];

Parameters​

NameTypeDescription
rowR
columnC
valueV

Overrides​

TableBase.set

stream​

undocumented

Definition​

stream(): Stream.NonEmpty<[R, C, V]>;

Overrides​

NonEmptyBase.stream, NonEmpty.stream

streamRows​

undocumented

Definition​

streamRows(): Stream.NonEmpty<R>;

Overrides​

NonEmpty.streamRows

streamValues​

undocumented

Definition​

streamValues(): Stream.NonEmpty<V>;

Overrides​

NonEmpty.streamValues

toArray​

undocumented

Definition​

toArray(): ArrayNonEmpty<[R, C, V]>;

Overrides​

NonEmpty.toArray

toBuilder​

undocumented

Definition​

toBuilder(): TpR['builder'];

Overrides​

TableBase.toBuilder

toJSON​

undocumented

Definition​

toJSON(): ToJSON<[R, [C, V][]][]>;

Overrides​

VariantTableBase.toJSON

toString​

undocumented

Definition​

toString(): string;

Overrides​

VariantTableBase.toString

updateAt​

undocumented

Definition​

updateAt<UR, UC>(row: RelatedTo<R, UR>, column: RelatedTo<C, UC>, update: Update<V>): TpR['nonEmpty'];

Type parameters​

NameDescription
UR
UC

Parameters​

NameTypeDescription
rowRelatedTo<R, UR>
columnRelatedTo<C, UC>
updateUpdate<V>

Overrides​

NonEmpty.updateAt