rcc documentation
  1. Classes
  2. Question

File

lib/core/src/items/questions/question.class.ts

Extends

Item

Index

Properties
Methods
Accessors

Constructor

constructor(idOrConfig: string | QuestionConfig)
Defined in lib/core/src/items/questions/question.class.ts:68
Parameters :
Name Type Optional
idOrConfig string | QuestionConfig No

Properties

Public id
Type : string
Inherited from Item
Defined in Item:50
Public max
Type : number
Defined in lib/core/src/items/questions/question.class.ts:57
Public meaning
Type : string
Defined in lib/core/src/items/questions/question.class.ts:53
Public min
Type : number
Defined in lib/core/src/items/questions/question.class.ts:56
Public options
Type : QuestionOptionConfig[]
Defined in lib/core/src/items/questions/question.class.ts:55
Public tags
Type : string[]
Defined in lib/core/src/items/questions/question.class.ts:58
Public translations
Type : TranslationList
Defined in lib/core/src/items/questions/question.class.ts:54
Public type
Type : string
Defined in lib/core/src/items/questions/question.class.ts:52
Public unit
Type : string
Defined in lib/core/src/items/questions/question.class.ts:59
Private Optional _config
Type : C
Inherited from Item
Defined in Item:54
Public Optional update$
Type : Observable<string>
Inherited from Item
Defined in Item:52
Protected Optional updateSubject
Type : Subject<string>
Inherited from Item
Defined in Item:51

Methods

Static acceptsAsConfig
acceptsAsConfig(x)
Inherited from Item
Defined in Item:61
Parameters :
Name Optional
x No
Returns : QuestionConfig
Public Async validateAnswer
validateAnswer(value)
Defined in lib/core/src/items/questions/question.class.ts:93
Parameters :
Name Optional
value No
Returns : Promise<void>
Static assertData
assertData(data)
Inherited from Item
Defined in Item:40
Parameters :
Name Optional
data No
Returns : never
Static findConfigs
findConfigs(data)
Inherited from Item
Defined in Item:32
Type parameters :
  • U
Parameters :
Name Optional
data No
Returns : U[]
Public matches
matches(query)
Inherited from Item
Defined in Item:80

TODO: Is this useful or needed anywhere?

Parameters :
Name Optional
query No
Returns : boolean
Public toJSON
toJSON()
Inherited from Item
Defined in Item:75
Returns : string

Accessors

config
getconfig()
Defined in lib/core/src/items/questions/question.class.ts:85
setconfig(config: QuestionConfig)
Defined in lib/core/src/items/questions/question.class.ts:80
Parameters :
Name Type Optional
config QuestionConfig No
Returns : void 
import	{	Item				}		from "../item.class"

import	{
			QuestionConfig,
			QuestionOptionConfig,
			TranslationList,
			isQuestionConfig
		}								from "./questions.commons"

import	{
			QuestionValidator
		}								from './question-validator'

import	{
			assert
		}								from '../../utils'

export const QuestionProperties = [
	'id',
	'type',
	'meaning',
	'translations',
	'options',
	'min',
	'max',
	'tags',
	'unit',
]

export function unknownConfig(id: string): QuestionConfig {
	return	{
				id: 			id,
				translations: 	{en: 'Unknown question: #'+id}, //todo use translationService
				type:			'unknown',
				meaning:		'Missing config for question: #'+id
			}
}


export class Question extends Item<QuestionConfig> {



	//INSTANCE



	declare public id			: string

	public type					: string
	public meaning				: string
	public translations			: TranslationList
	public options				: QuestionOptionConfig[]
	public min					: number
	public max					: number
	public tags					: string[]
	public unit					: string

	public static override acceptsAsConfig(x:unknown): x is QuestionConfig {
		return isQuestionConfig(x)
	}


	constructor(id:string)
	constructor(config:QuestionConfig)
	constructor(idOrConfig: string | QuestionConfig)

	constructor(idOrConfig: string | QuestionConfig){

		const config	=	typeof idOrConfig == 'string'
							?	unknownConfig(idOrConfig)
							:	idOrConfig

		super(config)

	}

	override set config(config: QuestionConfig){
		assert(Question.acceptsAsConfig(config), "Invalid Question config: "+JSON.stringify(config))
		QuestionProperties.forEach( (key:string) => (this as any)[key] = (config as any)[key] )
	}

	override get config(): QuestionConfig {
		const c: any = {}

		QuestionProperties.forEach( (key:string) => c[key] = (this as any)[key] )

		return (c as QuestionConfig)
	}

	public async validateAnswer(value:unknown):Promise<void>{
		return QuestionValidator.validateAnswer(value, this.config)
	}




}

results matching ""

    No results matching ""