JSONCompletion.md

codemirror-json-schema / JSONCompletion

Class: JSONCompletion

Table of contents

Constructors

• constructor

Methods

• addBooleanValueCompletion
• addDefaultValueCompletions
• addEnumValueCompletions
• addNullValueCompletion
• addSchemaValueCompletions
• applySnippetCompletion
• collectTypes
• doComplete
• doCompleteForSchema
• extendedRegExp
• getAppliedValue
• getInsertTextForGuessedValue
• getInsertTextForPlainText
• getInsertTextForProperty
• getInsertTextForPropertyName
• getInsertTextForString
• getInsertTextForValue
• getPropertyCompletions
• getSchemas
• getValueCompletions
• getValueFromLabel

Properties

• laxSchema
• mode
• opts
• originalSchema
• parser
• schema

Constructors

constructor

• new JSONCompletion(opts)

Parameters

Name	Type
opts	JSONCompletionOptions

Defined in

features/completion.ts:87

Methods

addBooleanValueCompletion

▸ Private addBooleanValueCompletion(value, collector): void

Parameters

Name	Type
value	boolean
collector	CompletionCollector

Returns

void

Defined in

features/completion.ts:856

---

addDefaultValueCompletions

▸ Private addDefaultValueCompletions(schema, collector, arrayDepth?): void

Parameters

Name	Type	Default value
schema	JSONSchema7	undefined
collector	CompletionCollector	undefined
arrayDepth	number	0

Returns

void

Defined in

features/completion.ts:785

---

addEnumValueCompletions

▸ Private addEnumValueCompletions(schema, collector): void

Parameters

Name	Type
schema	JSONSchema7
collector	CompletionCollector

Returns

void

Defined in

features/completion.ts:831

---

addNullValueCompletion

▸ Private addNullValueCompletion(collector): void

Parameters

Name	Type
collector	CompletionCollector

Returns

void

Defined in

features/completion.ts:866

---

addSchemaValueCompletions

▸ Private addSchemaValueCompletions(schema, types, collector): void

Parameters

Name	Type
schema	JSONSchema7Definition
types	Object
collector	CompletionCollector

Returns

void

Defined in

features/completion.ts:756

---

applySnippetCompletion

▸ Private applySnippetCompletion(completion): Completion

Parameters

Name	Type
completion	Completion

Returns

Completion

Defined in

features/completion.ts:301

---

collectTypes

▸ Private collectTypes(schema, types): void

Parameters

Name	Type
schema	JSONSchema7
types	Object

Returns

void

Defined in

features/completion.ts:873

---

doComplete

▸ doComplete(ctx): never[] | CompletionResult

Parameters

Name	Type
ctx	CompletionContext

Returns

never[] | CompletionResult

Defined in

features/completion.ts:92

---

doCompleteForSchema

▸ Private doCompleteForSchema(ctx, rootSchema): CompletionResult

Parameters

Name	Type
ctx	CompletionContext
rootSchema	JSONSchema7

Returns

CompletionResult

Defined in

features/completion.ts:124

---

extendedRegExp

▸ Private extendedRegExp(pattern): undefined | RegExp

Parameters

Name	Type
pattern	string

Returns

undefined | RegExp

Defined in

features/completion.ts:1038

---

getAppliedValue

▸ Private getAppliedValue(value): Object

Parameters

Name	Type
value	any

Returns

Object

Name	Type
apply	string
label	string

Defined in

features/completion.ts:1013

---

getInsertTextForGuessedValue

▸ Private getInsertTextForGuessedValue(value, separatorAfter?): string

Parameters

Name	Type	Default value
value	any	undefined
separatorAfter	string	""

Returns

string

Defined in

features/completion.ts:570

---

getInsertTextForPlainText

▸ Private getInsertTextForPlainText(text): string

Parameters

Name	Type
text	string

Returns

string

Defined in

features/completion.ts:593

---

getInsertTextForProperty

▸ Private getInsertTextForProperty(key, addValue, rawWord, rootSchema, propertySchema?): string

Parameters

Name	Type
key	string
addValue	boolean
rawWord	string
rootSchema	JSONSchema7
propertySchema?	JSONSchema7Definition

Returns

string

Defined in

features/completion.ts:422

---

getInsertTextForPropertyName

▸ Private getInsertTextForPropertyName(key, rawWord): string

Parameters

Name	Type
key	string
rawWord	string

Returns

string

Defined in

features/completion.ts:541

---

getInsertTextForString

▸ Private getInsertTextForString(value, prf?): string

Parameters

Name	Type	Default value
value	string	undefined
prf	string	"#"

Returns

string

Defined in

features/completion.ts:558

---

getInsertTextForValue

▸ Private getInsertTextForValue(value, separatorAfter): string

Parameters

Name	Type
value	any
separatorAfter	string

Returns

string

Defined in

features/completion.ts:597

---

getPropertyCompletions

▸ Private getPropertyCompletions(rootSchema, ctx, node, collector, addValue, rawWord): void

Parameters

Name	Type
rootSchema	JSONSchema7
ctx	CompletionContext
node	SyntaxNode
collector	CompletionCollector
addValue	boolean
rawWord	string

Returns

void

Defined in

features/completion.ts:310

---

getSchemas

▸ Private getSchemas(rootSchema, ctx): JSONSchema7Definition[]

Parameters

Name	Type
rootSchema	JSONSchema7
ctx	CompletionContext

Returns

JSONSchema7Definition[]

Defined in

features/completion.ts:888

---

getValueCompletions

▸ Private getValueCompletions(rootSchema, ctx, types, collector): undefined | { valuePrefix: string }

Parameters

Name	Type
rootSchema	JSONSchema7
ctx	CompletionContext
types	Object
collector	CompletionCollector

Returns

undefined | { valuePrefix: string }

Defined in

features/completion.ts:607

---

getValueFromLabel

▸ Private getValueFromLabel(value): string

Parameters

Name	Type
value	any

Returns

string

Defined in

features/completion.ts:1034

Properties

laxSchema

• Private laxSchema: null | JSONSchema7 = null

Inlined (expanded) top-level $ref if present. Does not contain any required properties and allows any additional properties everywhere.

Defined in

features/completion.ts:81

---

mode

• Private mode: JSONMode = MODES.JSON

Defined in

features/completion.ts:82

---

opts

• Private opts: JSONCompletionOptions

Defined in

features/completion.ts:87

---

originalSchema

• Private originalSchema: null | JSONSchema7 = null

Defined in

features/completion.ts:72

---

parser

• Private parser: DocumentParser

Defined in

features/completion.ts:83

---

schema

• Private schema: null | JSONSchema7 = null

Inlined (expanded) top-level $ref if present.

Defined in

features/completion.ts:76