Class Index

Manages index communication with a server

Hierarchy

AJAX
- Index

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Index(baseUrl?: string, cacheTimeout?: undefined | number, responseTimeout?: undefined | number): Index

Creates a new managed index instance.

Parameters
- Default value baseUrl: string = ""
```
   Base URL of the server
```
- Optional cacheTimeout: undefined | number
```
   Use 0 milliseconds to turn off all cache systems
```
- Optional responseTimeout: undefined | number
```
   Time in milliseconds to wait for a server response
```
Returns Index
Overrides AJAX.__constructor
- Defined in sources/lib/index.ts:112

Properties

baseUrl

baseUrl: string

Base URL of the server

cacheTimeout

cacheTimeout: number

Set to 0 to turn off all cache systems

responseTimeout

responseTimeout: number

Time in milliseconds to wait for a server response

Static Readonly SUBFOLDER

SUBFOLDER: "index/" = "index/"

Subfolder of index files

Methods

hasOpenRequest

hasOpenRequest(): boolean

Checks for open requests.

Returns boolean
Inherited from Index.hasOpenRequest
- Defined in external file

loadFileIndex

loadFileIndex(headline: string): Promise<IFileIndex>

Loads an index file from the server.

Parameters
- headline: string
```
   Headline of the index
```
Returns Promise < IFileIndex >
- Defined in sources/lib/index.ts:168

loadHeadlines

loadHeadlines(): Promise<Array<string>>

Loads the index of headline keys from the server.

Returns Promise < Array < string > >
- Defined in sources/lib/index.ts:146

request

request(urlPath: string): Promise<IAjaxResponse>

Requests a server resource.

Parameters
- urlPath: string
```
   Base relative path to the requested server resource.
```
Returns Promise < IAjaxResponse >
Inherited from Index.request
- Defined in external file

Static parse

parse(stringified: string): IFileIndex

Converts a text into a file index.

Parameters
- stringified: string
```
   Index text
```
Returns IFileIndex
- Defined in sources/lib/index.ts:59

Static stringify

stringify(fileIndex: IFileIndex): string

Converts a file index into a text.

Parameters
- fileIndex: IFileIndex
```
   File index
```
Returns string
- Defined in sources/lib/index.ts:91

Static stringifyHeadlines

stringifyHeadlines(headlines: Array<string>): string

Converts the headline index into a text.

Parameters
- headlines: Array<string>
```
   Headlines index
```
Returns string
- Defined in sources/lib/index.ts:109

Generated using TypeDoc