Index

Constructors

new Index()

new Index(options): Index

Parameters

Parameter	Type
options	IndexOptions

Returns

Index

Accessors

columns

Get Signature

get columns(): IndexedColumn[]

Returns

IndexedColumn[]

---

name

Get Signature

get name(): string

Returns

string

Methods

toJSON()

toJSON(table): {
  columns: {
     ascending: undefined | boolean;
     name: string;
     type: ColumnType;
    }[];
  name: string;
}

Parameters

Parameter	Type
table	Table<ColumnsType>

Returns

{
  columns: {
     ascending: undefined | boolean;
     name: string;
     type: ColumnType;
    }[];
  name: string;
}

Name	Type
columns	{ ascending: undefined | boolean; name: string; type: ColumnType; }[]
name	string

---

createAscending()

static createAscending(options, columnNames): Index

Parameters

Parameter	Type
options	IndexOptions
columnNames	string[]

Returns

Index