AproposCompletionSource

Hierarchy

CompletionSourceFuse
- AproposCompletionSource
  - HelpCompletionSource

Index

Constructors

constructor

new AproposCompletionSource(
    _parent: any,
    prefixes?: string[],
    className?: string,
    title?: string,
): AproposCompletionSource
Parameters
- _parent: any
- prefixes: string[] = ...
- className: string = "AproposCompletionSource"
- title: string = "Apropos"
Returns AproposCompletionSource
Overrides CompletionSourceFuse.constructor
- Defined in completions/Apropos.ts:31

Properties

`Private`_parent

_parent: any

args

args: string

completion

completion: string

fuse

fuse: any = undefined

fuseOptions

fuseOptions: object = ...

findAllMatches

findAllMatches: boolean = true

ignoreFieldNorm

ignoreFieldNorm: boolean = true

ignoreLocation

ignoreLocation: boolean = true

includeScore

includeScore: boolean = true

keys

keys: string[] = ...

minMatchCharLength

minMatchCharLength: number = 1

shouldSort

shouldSort: boolean = true

threshold

threshold: any = ...

`Protected`lastExstr

lastExstr: string

`Protected`lastFocused

lastFocused: CompletionOption

node

node: any

`Protected`optionContainer

optionContainer: HTMLElement = ...

options

options: AproposCompletionOption[]

`Protected`prefixes

prefixes: string[] = []

`Protected`sortScoredOptions

sortScoredOptions: boolean = false

trailingSpace

trailingSpace: boolean

Accessors

state

get state(): OptionState
Returns OptionState
Inherited from Completions.CompletionSourceFuse.state
- Defined in completions.ts:85
set state(newstate: OptionState): void
Control presentation of Source
Parameters
- newstate: OptionState
Returns void
Inherited from Completions.CompletionSourceFuse.state
- Defined in completions.ts:71

Methods

`Protected`canonicalisePrefix

canonicalisePrefix(prefix: string): string
Parameters
- prefix: string
Returns string
Inherited from CompletionSourceFuse.canonicalisePrefix
- Defined in completions.ts:66

completionForOption

completionForOption(option: CompletionOption): string
Parameters
- option: CompletionOption
Returns string
Inherited from CompletionSourceFuse.completionForOption
- Defined in completions.ts:246

`Protected`createOption

createOption(name: string, doc: string, flag: string): AproposCompletionOption
Parameters
- name: string
- doc: string
- flag: string
Returns AproposCompletionOption
- Defined in completions/Apropos.ts:42

deselect

deselect(): void
Returns void
Inherited from CompletionSourceFuse.deselect
- Defined in completions.ts:98

filter

filter(exstr: string): Promise<void>
Update node to display completions relevant to exstr
Parameters
- exstr: string
Returns Promise<void>
Overrides CompletionSourceFuse.filter
- Defined in completions/Apropos.ts:46

next(inc?: number): Promise<any>
Parameters
- inc: number = 1
Returns Promise<any>
Inherited from CompletionSourceFuse.next
- Defined in completions.ts:331

onInput

onInput(exstr: string): Promise<void>
Parameters
- exstr: string
Returns Promise<void>
Inherited from CompletionSourceFuse.onInput
- Defined in completions.ts:353

prev(inc?: number): Promise<boolean>
Parameters
- inc: number = 1
Returns Promise<boolean>
Inherited from CompletionSourceFuse.prev
- Defined in completions.ts:94

scoredOptions

scoredOptions(query: string): ScoredOption[]
Rtn sorted array of {option, score}
Parameters
- query: string
Returns ScoredOption[]
Inherited from CompletionSourceFuse.scoredOptions
- Defined in completions.ts:281

select

select(option: CompletionOption): void
Parameters
- option: CompletionOption
Returns void
Inherited from CompletionSourceFuse.select
- Defined in completions.ts:258

setStateFromScore

setStateFromScore(scoredOpts: ScoredOption[], autoselect?: boolean): void
Set option state by score

For now just displays all scored elements (see threshold in fuse) and focus the best match.
Parameters
- scoredOpts: ScoredOption[]
- autoselect: boolean = false
Returns void
Inherited from CompletionSourceFuse.setStateFromScore
- Defined in completions.ts:298

shouldRefresh

shouldRefresh(): boolean
Returns boolean
Inherited from CompletionSourceFuse.shouldRefresh
- Defined in completions.ts:89

splitOnPrefix

splitOnPrefix(exstr: string): string[]
Parameters
- exstr: string
Returns string[]
Inherited from CompletionSourceFuse.splitOnPrefix
- Defined in completions.ts:270

updateChain

updateChain(): void
Returns void
Overrides CompletionSourceFuse.updateChain
- Defined in completions/Apropos.ts:162

updateDisplay

updateDisplay(): void
Call to replace the current display

Returns void
Inherited from CompletionSourceFuse.updateDisplay
- Defined in completions.ts:325

visibleCompletions

visibleCompletions(): string[]
Returns string[]
Inherited from CompletionSourceFuse.visibleCompletions
- Defined in completions.ts:251

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AproposCompletionSource

Properties

Private_parent

args

completion

fuse

fuseOptions

findAllMatches

ignoreFieldNorm

ignoreLocation

includeScore

keys

minMatchCharLength

shouldSort

threshold

ProtectedlastExstr

ProtectedlastFocused

node

ProtectedoptionContainer

options

Protectedprefixes

ProtectedsortScoredOptions

trailingSpace

Accessors

state

Returns OptionState

Parameters

Returns void

Methods

ProtectedcanonicalisePrefix

Parameters

Returns string

completionForOption

Parameters

Returns string

ProtectedcreateOption

Parameters

Returns AproposCompletionOption

deselect

Returns void

filter

Parameters

Returns Promise<void>

next

Parameters

Returns Promise<any>

onInput

Parameters

Returns Promise<void>

prev

Parameters

Returns Promise<boolean>

scoredOptions

Parameters

Returns ScoredOption[]

select

Parameters

Returns void

setStateFromScore

Parameters

Returns void

shouldRefresh

Returns boolean

splitOnPrefix

Parameters

Returns string[]

updateChain

Returns void

updateDisplay

Returns void

visibleCompletions

`Private`_parent

`Protected`lastExstr

`Protected`lastFocused

`Protected`optionContainer

`Protected`prefixes

`Protected`sortScoredOptions

`Protected`canonicalisePrefix

`Protected`createOption