Module schema

Index

Interfaces

Type aliases

Type aliases

FieldTypeName

FieldTypeName: "String" | "Boolean" | "Number" | "SimpleSchema.Integer" | "Array" | "Object" | "JSON" | "Date"

VulcanCoreInput

VulcanCoreInput: StandardFieldInput | AdvancedFieldInput

VulcanFieldInput

VulcanFieldInput: VulcanCoreInput | string | any

VulcanFieldSchemaServer

VulcanFieldSchemaServer<TField>: VulcanFieldSchema<TField> & VulcanFieldServer<TField>

Type parameters

TField = any

VulcanFieldSchemaShared

VulcanFieldSchemaShared<TField>: VulcanFieldSchema<TField> & VulcanFieldShared<TField>

Type parameters

TField = any

VulcanFieldType

VulcanFieldType: SchemaDefinition<any>["type"] | VulcanFieldSchema

VulcanSchema

VulcanSchema<TSchemaFieldExtension>: {}

Type parameters

TSchemaFieldExtension = AnyObject

Type declaration

[key: string]: VulcanFieldSchema & TSchemaFieldExtension

VulcanSchemaServer

VulcanSchemaServer<TSchemaFieldExtension>: {}

server-only

Type parameters

TSchemaFieldExtension = AnyObject

Type declaration

[key: string]: VulcanFieldSchemaServer & TSchemaFieldExtension

Functions

Const forEachDocumentField

forEachDocumentField(document: VulcanDocument, schema: VulcanSchema<AnyObject>, callback: (input: ForEachFieldInput) => void, currentPath?: string): void

- Defined in packages/schema/schema-utils.ts:136
Iterate over a document fields and run a callback with side effect Works recursively for nested fields and arrays of objects (but excluding blackboxed objects, native JSON, and arrays of native values)

Parameters
- document: VulcanDocument
  
  Current document
- schema: VulcanSchema<AnyObject>
  
  Document schema
- callback: (input: ForEachFieldInput) => void
  
  Called on each field with the corresponding field schema, including fields of nested objects and arrays of nested object
  - - (input: ForEachFieldInput): void
    - Parameters
      - input: ForEachFieldInput
      Returns void
- currentPath: string = ""
  
  Global path of the document (to track recursive calls)
Returns void

Const getAllowedValues

getAllowedValues(field: any): any

- Defined in packages/schema/simpleSchema-utils.ts:15
Parameters
- field: any
Returns any

Const getArrayChild

getArrayChild(fieldName: string, schema: VulcanSchema<AnyObject>): VulcanFieldSchema<any>

- Defined in packages/schema/simpleSchema-utils.ts:72
Parameters
- fieldName: string
- schema: VulcanSchema<AnyObject>
Returns VulcanFieldSchema<any>

Const getArrayChildSchema

getArrayChildSchema(fieldName: any, schema: any): VulcanSchema<AnyObject>

- Defined in packages/schema/simpleSchema-utils.ts:85
Parameters
- fieldName: any
- schema: any
Returns VulcanSchema<AnyObject>

Const getCreateableFields

getCreateableFields(schema: any): string[]

- Defined in packages/schema/schema-utils.ts:38
Parameters
- schema: any
Returns string[]

Const getFieldTypeName

getFieldTypeName(field: VulcanFieldSchema<any>): FieldTypeName

- Defined in packages/schema/simpleSchema-utils.ts:36
Parameters
- field: VulcanFieldSchema<any>
Returns FieldTypeName

Const getFragmentFieldNames

getFragmentFieldNames(__namedParameters: Object): string[]

- Defined in packages/schema/schema-utils.ts:81
Parameters
- __namedParameters: Object
Returns string[]

Const getNestedSchema

getNestedSchema(field: VulcanFieldSchema<any>): VulcanSchema<AnyObject>

- Defined in packages/schema/simpleSchema-utils.ts:81
Parameters
- field: VulcanFieldSchema<any>
Returns VulcanSchema<AnyObject>

Const getReadableFields

getReadableFields(schema: any): string[]

- Defined in packages/schema/schema-utils.ts:31
Get all readable fields of a schema

// NOTE: this include fields that should'n't go into the default fragment (pure virtual fields and resolved fields) // use getFragmentFieldNames for fragments

Parameters
- schema: any
Returns string[]

Const getUpdateableFields

getUpdateableFields(schema: any): string[]

- Defined in packages/schema/schema-utils.ts:45
Parameters
- schema: any
Returns string[]

Const getValidFields

getValidFields(schema: any): string[]

- Defined in packages/schema/schema-utils.ts:17
Parameters
- schema: any
Returns string[]

Const hasAllowedValues

hasAllowedValues(field: any): boolean

- Defined in packages/schema/simpleSchema-utils.ts:17
Parameters
- field: any
Returns boolean

Const hasArrayChild

hasArrayChild(fieldName: string, schema: VulcanSchema<AnyObject>): boolean

- Defined in packages/schema/simpleSchema-utils.ts:76
Parameters
- fieldName: string
- schema: VulcanSchema<AnyObject>
Returns boolean

Const hasArrayNestedChild

hasArrayNestedChild(fieldName: any, schema: any): boolean

- Defined in packages/schema/simpleSchema-utils.ts:88
Parameters
- fieldName: any
- schema: any
Returns boolean

Const hasNestedSchema

hasNestedSchema(field: VulcanFieldSchema<any>): boolean

- Defined in packages/schema/simpleSchema-utils.ts:69
Parameters
- field: VulcanFieldSchema<any>
Returns boolean

Const isArrayChildField

isArrayChildField(fieldName: any): boolean

- Defined in packages/schema/simpleSchema-utils.ts:66
Parameters
- fieldName: any
Returns boolean

Const isBlackbox

isBlackbox(field: VulcanFieldSchema<any>): boolean

- Defined in packages/schema/simpleSchema-utils.ts:62
Parameters
- field: VulcanFieldSchema<any>
Returns boolean

Const shouldAddOriginalField

shouldAddOriginalField(fieldName: string, field: VulcanFieldSchema<any>): boolean

- Defined in packages/schema/schema-utils.ts:62
Parameters
- fieldName: string
- field: VulcanFieldSchema<any>
Returns boolean

Const toSimpleSchema

toSimpleSchema(schema: VulcanSchema<AnyObject>): SimpleSchema

- Defined in packages/schema/simpleSchema-utils.ts:100
Convert the Vulcan schema to an evaluated schema Calling new SimpleSchema around a Vulcan is not sufficient We also need to call it for children fields

/!\ Supports only one level of nesting

Parameters
- schema: VulcanSchema<AnyObject>
Returns SimpleSchema

Const unarrayfyFieldName

unarrayfyFieldName(fieldName: any): any

- Defined in packages/schema/simpleSchema-utils.ts:10
Parameters
- fieldName: any
Returns any

Generated using TypeDoc