Skip to content

Latest commit

 

History

History
3469 lines (2170 loc) · 88 KB

README.md

File metadata and controls

3469 lines (2170 loc) · 88 KB

SMART xAPI DSL

Index

Modules

Enumerations

Interfaces

Type aliases

Variables

Functions

Object literals


Type aliases

Activity

Ƭ Activity: BaseActivity | InteractionActivity

Defined in node_modules/@gradiant/xapi-dsl/types/object/activity/activity.d.ts:9


ActivityTypeChecker

Ƭ ActivityTypeChecker: function

Defined in src/activity-types/activity-types.checkers.ts:15

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


Actor

Ƭ Actor: Agent | Group

Defined in node_modules/@gradiant/xapi-dsl/types/actor/actor.d.ts:6


ActorObject

Ƭ ActorObject: Actor & object

Defined in node_modules/@gradiant/xapi-dsl/types/object/actor-object.d.ts:5


Agent

Ƭ Agent: AccountAgent | MboxAgent | OpenIdAgent | MboxSha1SumAgent

Defined in node_modules/@gradiant/xapi-dsl/types/actor/agent/agent.d.ts:12


AttemptActivityType

Ƭ AttemptActivityType: "https://w3id.org/xapi/smart/activity/attempt"

Defined in src/activity-types/activity-type.types.ts:63


AudioActivityType

Ƭ AudioActivityType: "https://w3id.org/xapi/smart/activity/audio"

Defined in src/activity-types/activity-type.types.ts:54


AudioRecordingActivityType

Ƭ AudioRecordingActivityType: "https://w3id.org/xapi/smart/activity/audio-recording"

Defined in src/activity-types/activity-type.types.ts:12


AudioVideoType

Ƭ AudioVideoType: AudioActivityType | VideoActivityType

Defined in src/activity-types/activity-type.types.ts:56


ClosedResponseType

Ƭ ClosedResponseType: DropDownChoiceActivityType | FillInTheGapsActivityType | GenericClosedResponseActivityType | MatchingPairsActivityType | MultipleChoiceActivityType | ImageMultipleChoiceActivityType | SingleChoiceActivityType | WordsBankActivityType | MatrixMultipleChoiceActivityType | MatrixSingleChoiceActivityType | ResponseInImageActivityType | DraggingImageActivityType

Defined in src/activity-types/activity-type.types.ts:40


DebateActivityType

Ƭ DebateActivityType: "https://w3id.org/xapi/smart/activity/discussion"

Defined in src/activity-types/activity-type.types.ts:61


DiscussionActivityType

Ƭ DiscussionActivityType: "http://id.tincanapi.com/activitytype/discussion"

Defined in src/activity-types/activity-type.types.ts:58


DraggingImageActivityType

Ƭ DraggingImageActivityType: "https://w3id.org/xapi/smart/activity/dragging-image"

Defined in src/activity-types/activity-type.types.ts:39


DrawActivityType

Ƭ DrawActivityType: "https://w3id.org/xapi/smart/activity/draw"

Defined in src/activity-types/activity-type.types.ts:13


DropDownChoiceActivityType

Ƭ DropDownChoiceActivityType: "https://w3id.org/xapi/smart/activity/drop-down-choice"

Defined in src/activity-types/activity-type.types.ts:28


Duration

Ƭ Duration: string

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/duration.d.ts:20


EssayActivityType

Ƭ EssayActivityType: "https://w3id.org/xapi/smart/activity/essay"

Defined in src/activity-types/activity-type.types.ts:14


FeedbackType

Ƭ FeedbackType: QuestionType | ReviewType | SurveyType

Defined in src/activity-types/activity-type.types.ts:72


FillInTheGapsActivityType

Ƭ FillInTheGapsActivityType: "https://w3id.org/xapi/smart/activity/fill-in-the-gaps"

Defined in src/activity-types/activity-type.types.ts:29


ForumReplyActivityType

Ƭ ForumReplyActivityType: "http://id.tincanapi.com/activitytype/forum-reply"

Defined in src/activity-types/activity-type.types.ts:59


ForumTopicActivityType

Ƭ ForumTopicActivityType: "http://id.tincanapi.com/activitytype/forum-topic"

Defined in src/activity-types/activity-type.types.ts:60


GenericClosedResponseActivityType

Ƭ GenericClosedResponseActivityType: "https://w3id.org/xapi/smart/activity/closed-response"

Defined in src/activity-types/activity-type.types.ts:30


GenericOpenAnswerActivityType

Ƭ GenericOpenAnswerActivityType: "https://w3id.org/xapi/smart/activity/open-answer"

Defined in src/activity-types/activity-type.types.ts:15


Group

Ƭ Group: AnonymousGroup | IdentifiedGroup

Defined in node_modules/@gradiant/xapi-dsl/types/actor/group/group.d.ts:15


IRI

Ƭ IRI: string

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/iri.d.ts:6


IRL

Ƭ IRL: string

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/irl.d.ts:6


IdentifiedGroup

Ƭ IdentifiedGroup: AccountGroup | MboxGroup | MboxSha1SumGroup | OpenIdGroup

Defined in node_modules/@gradiant/xapi-dsl/types/actor/group/identified-group.d.ts:13


ImageMultipleChoiceActivityType

Ƭ ImageMultipleChoiceActivityType: "https://w3id.org/xapi/smart/activity/image-multiple-choice"

Defined in src/activity-types/activity-type.types.ts:33


Integer

Ƭ Integer: number

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/integer.d.ts:1


InteractionActivity

Ƭ InteractionActivity: TrueFalseActivity | ChoiceActivity | FillInActivity | LongFillInActvity | MatchingActivity | PerformanceActivity | SequenceActivity | LikertActivity | NumericActivity | OtherActivity

Defined in node_modules/@gradiant/xapi-dsl/types/object/activity/interaction-activity.d.ts:23


InteractionDefinition

Ƭ InteractionDefinition: ChoiceDefinition | FillInDefinition | LikertDefinition | LongFillInDefinition | MatchingDefinition | NumericDefinition | OtherDefinition | PerformanceDefinition | SequenceDefinition | TrueFalseDefinition

Defined in node_modules/@gradiant/xapi-dsl/types/object/activity/interaction/definitions/interaction-definition.d.ts:11


InternetMediaType

Ƭ InternetMediaType: string

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/internet-media-type.d.ts:1


InverseFunctionalIdentifier

Ƭ InverseFunctionalIdentifier: MboxIdentifier | MboxSha1SumIdentifier | OpenIdIdentifier | AccountIdentifier

Defined in node_modules/@gradiant/xapi-dsl/types/actor/ifi/ifi.d.ts:12


LikertType

Ƭ LikertType: "https://w3id.org/xapi/smart/activity/likert"

Defined in src/activity-types/activity-type.types.ts:87


MailtoIRI

Ƭ MailtoIRI: IRI

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/mailto-iri.d.ts:2


MatchingPairsActivityType

Ƭ MatchingPairsActivityType: "https://w3id.org/xapi/smart/activity/matching-pairs"

Defined in src/activity-types/activity-type.types.ts:31


MathFormulaeActivityType

Ƭ MathFormulaeActivityType: "https://w3id.org/xapi/smart/activity/math-formulae"

Defined in src/activity-types/activity-type.types.ts:18


MatrixMultipleChoiceActivityType

Ƭ MatrixMultipleChoiceActivityType: "https://w3id.org/xapi/smart/activity/matrix-multiple-choice"

Defined in src/activity-types/activity-type.types.ts:36


MatrixSingleChoiceActivityType

Ƭ MatrixSingleChoiceActivityType: "https://w3id.org/xapi/smart/activity/matrix-single-choice"

Defined in src/activity-types/activity-type.types.ts:37


MultipleChoiceActivityType

Ƭ MultipleChoiceActivityType: "https://w3id.org/xapi/smart/activity/multiple-choice"

Defined in src/activity-types/activity-type.types.ts:32


NonInteractiveAttemptActivityType

Ƭ NonInteractiveAttemptActivityType: "https://w3id.org/xapi/smart/activity/no-interactive"

Defined in src/activity-types/activity-type.types.ts:64


NonInteractiveType

Ƭ NonInteractiveType: AttemptActivityType | NonInteractiveAttemptActivityType

Defined in src/activity-types/activity-type.types.ts:65


Object

Ƭ Object: Activity | StatementRef | SubStatement | ActorObject

Defined in node_modules/@gradiant/xapi-dsl/types/object/object.d.ts:10


OpenAnswerType

Ƭ OpenAnswerType: AudioRecordingActivityType | EssayActivityType | DrawActivityType | GenericOpenAnswerActivityType | UploadFileActivityType | VideoRecordingActivityType | MathFormulaeActivityType

Defined in src/activity-types/activity-type.types.ts:19


OtherType

Ƭ OtherType: LikertType | QuizType | PasswordType

Defined in src/activity-types/activity-type.types.ts:91


PasswordType

Ƭ PasswordType: "https://w3id.org/xapi/smart/activity/password"

Defined in src/activity-types/activity-type.types.ts:89


ProcessableActivityType

Ƭ ProcessableActivityType: OpenAnswerType | ClosedResponseType | AudioVideoType

Defined in src/activity-types/activity-type.types.ts:67


QuestionType

Ƭ QuestionType: "http://activitystrea.ms/schema/1.0/question"

Defined in src/activity-types/activity-type.types.ts:69


QuizType

Ƭ QuizType: "https://w3id.org/xapi/smart/activity/quiz"

Defined in src/activity-types/activity-type.types.ts:88


RecipeChecker

Ƭ RecipeChecker: function

Defined in src/recipes/recipes.checkers.ts:4

Type declaration

▸(recipe: string): boolean

Parameters:

Name Type
recipe string

Returns: boolean


ResponseInImageActivityType

Ƭ ResponseInImageActivityType: "https://w3id.org/xapi/smart/activity/response-in-image"

Defined in src/activity-types/activity-type.types.ts:38


ReviewType

Ƭ ReviewType: "http://activitystrea.ms/schema/1.0/review"

Defined in src/activity-types/activity-type.types.ts:70


ScormChoiceActivityType

Ƭ ScormChoiceActivityType: "http://imsglobal.org/qti/choice"

Defined in src/activity-types/activity-type.types.ts:74


ScormGenericActivityType

Ƭ ScormGenericActivityType: "https://w3id.org/xapi/smart/activity/scorm"

Defined in src/activity-types/activity-type.types.ts:78


ScormInlineChoiceActivityType

Ƭ ScormInlineChoiceActivityType: "http://imsglobal.org/qti/inlineChoice"

Defined in src/activity-types/activity-type.types.ts:76


ScormMultipleChoiceActivityType

Ƭ ScormMultipleChoiceActivityType: "http://imsglobal.org/qti/choiceMultiple"

Defined in src/activity-types/activity-type.types.ts:75


ScormTextEntryActivityType

Ƭ ScormTextEntryActivityType: "http://imsglobal.org/qti/textEntry"

Defined in src/activity-types/activity-type.types.ts:77


ScormType

Ƭ ScormType: ScormChoiceActivityType | ScormMultipleChoiceActivityType | ScormInlineChoiceActivityType | ScormTextEntryActivityType | ScormGenericActivityType

Defined in src/activity-types/activity-type.types.ts:80


Sha1Sum

Ƭ Sha1Sum: string

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/sha1-sum.d.ts:1


Sha2Sum

Ƭ Sha2Sum: string

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/sha2-sum.d.ts:1


SingleChoiceActivityType

Ƭ SingleChoiceActivityType: "https://w3id.org/xapi/smart/activity/single-choice"

Defined in src/activity-types/activity-type.types.ts:34


SurveyType

Ƭ SurveyType: "http://id.tincanapi.com/activitytype/survey"

Defined in src/activity-types/activity-type.types.ts:71


Timestamp

Ƭ Timestamp: string

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/timestamp.d.ts:14


URI

Ƭ URI: string

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/uri.d.ts:1


UUID

Ƭ UUID: string

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/uuid.d.ts:6


UploadFileActivityType

Ƭ UploadFileActivityType: "https://w3id.org/xapi/smart/activity/upload-file"

Defined in src/activity-types/activity-type.types.ts:16


VerbChecker

Ƭ VerbChecker: function

Defined in src/verbs/verbs.types.ts:7

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


VerbIdChecker

Ƭ VerbIdChecker: function

Defined in src/verbs/verbs.types.ts:1

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


Version

Ƭ Version: string

Defined in node_modules/@gradiant/xapi-dsl/types/utils/types/version.d.ts:6


VideoActivityType

Ƭ VideoActivityType: "https://w3id.org/xapi/smart/activity/video"

Defined in src/activity-types/activity-type.types.ts:55


VideoRecordingActivityType

Ƭ VideoRecordingActivityType: "https://w3id.org/xapi/smart/activity/video-recording"

Defined in src/activity-types/activity-type.types.ts:17


WordsBankActivityType

Ƭ WordsBankActivityType: "https://w3id.org/xapi/smart/activity/words-bank"

Defined in src/activity-types/activity-type.types.ts:35


Variables

<Const> assessableTypes

● assessableTypes: Set<string> = new Set([ openAnswerTypes.audioRecording, openAnswerTypes.draw, openAnswerTypes.essay, openAnswerTypes.genericOpenAnswer, openAnswerTypes.uploadFile, openAnswerTypes.videoRecording, openAnswerTypes.mathFormulae, closedResponseTypes.matchingPairs, closedResponseTypes.singleChoice, closedResponseTypes.multipleChoice, closedResponseTypes.imageMultipleChoice, closedResponseTypes.dropDownChoice, closedResponseTypes.binaryChoice, closedResponseTypes.genericClosedResponse, closedResponseTypes.wordsBank, closedResponseTypes.fillInTheGaps, closedResponseTypes.matrixSingleChoice, closedResponseTypes.matrixMultipleChoice, closedResponseTypes.responseInImage, closedResponseTypes.draggingImage ])

Defined in src/activity-types/activity-types.ts:130


<Const> dsl

● dsl: object

Defined in node_modules/@gradiant/xapi-dsl/dsl/dsl.d.ts:8

Type declaration


<Const> ids

● ids: object

Defined in node_modules/@gradiant/xapi-dsl/dsl/verbs/ids/index.d.ts:9

Type declaration


<Const> isAccessed

● isAccessed: function = isVerbId(verbs.accessed.id)

Defined in src/verbs/verb-ids.checkers.ts:119

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isAccessedVerb

● isAccessedVerb: function = isVerb(verbs.accessed)

Defined in src/verbs/verbs.checkers.ts:119

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isAnswered

● isAnswered: function = isVerbId(verbs.answered.id)

Defined in src/verbs/verb-ids.checkers.ts:14

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isAnsweredVerb

● isAnsweredVerb: function = isVerb(verbs.answered)

Defined in src/verbs/verbs.checkers.ts:14

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isAttempt

● isAttempt: function = isActivityType(nonInteractiveTypes.attempt)

Defined in src/activity-types/activity-types.checkers.ts:224

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isAudio

● isAudio: function = isActivityType(audioVideoTypes.audio)

Defined in src/activity-types/activity-types.checkers.ts:203

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isAudioRecording

● isAudioRecording: function = isActivityType(openAnswerTypes.audioRecording)

Defined in src/activity-types/activity-types.checkers.ts:126

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isAudioVideo

● isAudioVideo: ActivityTypeChecker = anyPass([isAudio, isVideo])

Defined in src/activity-types/activity-types.checkers.ts:216


<Const> isAudioVideoRecipe

● isAudioVideoRecipe: function = isRecipe(recipes.audioVideo)

Defined in src/recipes/recipes.checkers.ts:25

Type declaration

▸(recipe: string): boolean

Parameters:

Name Type
recipe string

Returns: boolean


<Const> isBinaryChoice

● isBinaryChoice: function = isActivityType(closedResponseTypes.binaryChoice)

Defined in src/activity-types/activity-types.checkers.ts:28

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isBook

● isBook: function = isActivityType(bookTypes.book)

Defined in src/activity-types/activity-types.checkers.ts:245

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isBookContainer

● isBookContainer: ActivityTypeChecker = anyPass([isBook, isUnit, isLesson])

Defined in src/activity-types/activity-types.checkers.ts:290


<Const> isClosedResponse

● isClosedResponse: ActivityTypeChecker = anyPass([ isBinaryChoice, isDropDownChoice, isFillInTheGaps, isGenericClosedResponse, isMatchingPairs, isMultipleChoice, isImageMultipleChoice, isSingleChoice, isWordsBank, isMatrixMultipleChoice, isMatrixSingleChoice, isResponseInImage, isDraggingImage ])

Defined in src/activity-types/activity-types.checkers.ts:104


<Const> isClosedResponseRecipe

● isClosedResponseRecipe: function = isRecipe(recipes.closedResponse)

Defined in src/recipes/recipes.checkers.ts:20

Type declaration

▸(recipe: string): boolean

Parameters:

Name Type
recipe string

Returns: boolean


<Const> isCompleted

● isCompleted: function = isVerbId(verbs.completed.id)

Defined in src/verbs/verb-ids.checkers.ts:69

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isCompletedVerb

● isCompletedVerb: function = isVerb(verbs.completed)

Defined in src/verbs/verbs.checkers.ts:69

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isCreated

● isCreated: function = isVerbId(verbs.created.id)

Defined in src/verbs/verb-ids.checkers.ts:124

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isCreatedVerb

● isCreatedVerb: function = isVerb(verbs.created)

Defined in src/verbs/verbs.checkers.ts:124

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isDebate

● isDebate: function = isActivityType(discussionTypes.debate)

Defined in src/activity-types/activity-types.checkers.ts:195

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isDeleted

● isDeleted: function = isVerbId(verbs.deleted.id)

Defined in src/verbs/verb-ids.checkers.ts:94

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isDeletedVerb

● isDeletedVerb: function = isVerb(verbs.deleted)

Defined in src/verbs/verbs.checkers.ts:94

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isDisabled

● isDisabled: function = isVerbId(verbs.disabled.id)

Defined in src/verbs/verb-ids.checkers.ts:79

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isDisabledVerb

● isDisabledVerb: function = isVerb(verbs.disabled)

Defined in src/verbs/verbs.checkers.ts:79

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isDiscussion

● isDiscussion: function = isActivityType(discussionTypes.discussion)

Defined in src/activity-types/activity-types.checkers.ts:180

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isDiscussionRecipe

● isDiscussionRecipe: function = isRecipe(recipes.discussion)

Defined in src/recipes/recipes.checkers.ts:30

Type declaration

▸(recipe: string): boolean

Parameters:

Name Type
recipe string

Returns: boolean


<Const> isDraggingImage

● isDraggingImage: function = isActivityType(closedResponseTypes.draggingImage)

Defined in src/activity-types/activity-types.checkers.ts:88

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isDraw

● isDraw: function = isActivityType(openAnswerTypes.draw)

Defined in src/activity-types/activity-types.checkers.ts:131

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isDropDownChoice

● isDropDownChoice: function = isActivityType(closedResponseTypes.dropDownChoice)

Defined in src/activity-types/activity-types.checkers.ts:33

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isEdited

● isEdited: function = isVerbId(verbs.edited.id)

Defined in src/verbs/verb-ids.checkers.ts:134

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isEditedVerb

● isEditedVerb: function = isVerb(verbs.edited)

Defined in src/verbs/verbs.checkers.ts:134

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isEnabled

● isEnabled: function = isVerbId(verbs.enabled.id)

Defined in src/verbs/verb-ids.checkers.ts:74

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isEnabledVerb

● isEnabledVerb: function = isVerb(verbs.enabled)

Defined in src/verbs/verbs.checkers.ts:74

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isEssay

● isEssay: function = isActivityType(openAnswerTypes.essay)

Defined in src/activity-types/activity-types.checkers.ts:136

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isEvaluated

● isEvaluated: function = isVerbId(verbs.evaluated.id)

Defined in src/verbs/verb-ids.checkers.ts:19

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isEvaluatedVerb

● isEvaluatedVerb: function = isVerb(verbs.evaluated)

Defined in src/verbs/verbs.checkers.ts:19

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isFailed

● isFailed: function = isVerbId(verbs.failed.id)

Defined in src/verbs/verb-ids.checkers.ts:29

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isFailedVerb

● isFailedVerb: function = isVerb(verbs.failed)

Defined in src/verbs/verbs.checkers.ts:29

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isFeedback

● isFeedback: ActivityTypeChecker = anyPass([isQuestion, isReview, isSurvey])

Defined in src/activity-types/activity-types.checkers.ts:366


<Const> isFillInTheGaps

● isFillInTheGaps: function = isActivityType(closedResponseTypes.fillInTheGaps)

Defined in src/activity-types/activity-types.checkers.ts:38

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isForumReply

● isForumReply: function = isActivityType(discussionTypes.forumReply)

Defined in src/activity-types/activity-types.checkers.ts:185

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isForumTopic

● isForumTopic: function = isActivityType(discussionTypes.forumTopic)

Defined in src/activity-types/activity-types.checkers.ts:190

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isGenericClosedResponse

● isGenericClosedResponse: function = isActivityType(closedResponseTypes.genericClosedResponse)

Defined in src/activity-types/activity-types.checkers.ts:43

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isGenericOpenAnswer

● isGenericOpenAnswer: function = isActivityType(openAnswerTypes.genericOpenAnswer)

Defined in src/activity-types/activity-types.checkers.ts:141

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isImageMultipleChoice

● isImageMultipleChoice: function = isActivityType(closedResponseTypes.imageMultipleChoice)

Defined in src/activity-types/activity-types.checkers.ts:58

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isInitialized

● isInitialized: function = isVerbId(verbs.initialized.id)

Defined in src/verbs/verb-ids.checkers.ts:34

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isInitializedVerb

● isInitializedVerb: function = isVerb(verbs.initialized)

Defined in src/verbs/verbs.checkers.ts:34

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isInteracted

● isInteracted: function = isVerbId(verbs.interacted.id)

Defined in src/verbs/verb-ids.checkers.ts:39

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isInteractedVerb

● isInteractedVerb: function = isVerb(verbs.interacted)

Defined in src/verbs/verbs.checkers.ts:39

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isJoined

● isJoined: function = isVerbId(verbs.joined.id)

Defined in src/verbs/verb-ids.checkers.ts:129

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isJoinedVerb

● isJoinedVerb: function = isVerb(verbs.joined)

Defined in src/verbs/verbs.checkers.ts:129

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isLaeProcessable

● isLaeProcessable: ActivityTypeChecker = anyPass([isOpenAnswer, isClosedResponse, isAudioVideo])

Defined in src/activity-types/activity-types.checkers.ts:315


<Const> isLesson

● isLesson: function = isActivityType(bookTypes.lesson)

Defined in src/activity-types/activity-types.checkers.ts:255

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isLiked

● isLiked: function = isVerbId(verbs.liked.id)

Defined in src/verbs/verb-ids.checkers.ts:99

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isLikedVerb

● isLikedVerb: function = isVerb(verbs.liked)

Defined in src/verbs/verbs.checkers.ts:99

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isLikert

● isLikert: function = isActivityType(otherTypes.likert)

Defined in src/activity-types/activity-types.checkers.ts:268

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isLikertRecipe

● isLikertRecipe: function = isRecipe(recipes.likert)

Defined in src/recipes/recipes.checkers.ts:45

Type declaration

▸(recipe: string): boolean

Parameters:

Name Type
recipe string

Returns: boolean


<Const> isListened

● isListened: function = isVerbId(verbs.listen.id)

Defined in src/verbs/verb-ids.checkers.ts:54

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isListenedVerb

● isListenedVerb: function = isVerb(verbs.listen)

Defined in src/verbs/verbs.checkers.ts:54

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isMatchingPairs

● isMatchingPairs: function = isActivityType(closedResponseTypes.matchingPairs)

Defined in src/activity-types/activity-types.checkers.ts:48

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isMathFormulae

● isMathFormulae: function = isActivityType(openAnswerTypes.mathFormulae)

Defined in src/activity-types/activity-types.checkers.ts:152

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isMatrixMultipleChoice

● isMatrixMultipleChoice: function = isActivityType(closedResponseTypes.matrixMultipleChoice)

Defined in src/activity-types/activity-types.checkers.ts:73

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isMatrixSingleChoice

● isMatrixSingleChoice: function = isActivityType(closedResponseTypes.matrixSingleChoice)

Defined in src/activity-types/activity-types.checkers.ts:78

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isMinigameRecipe

● isMinigameRecipe: function = isRecipe(recipes.minigame)

Defined in src/recipes/recipes.checkers.ts:50

Type declaration

▸(recipe: string): boolean

Parameters:

Name Type
recipe string

Returns: boolean


<Const> isMultipleChoice

● isMultipleChoice: function = isActivityType(closedResponseTypes.multipleChoice)

Defined in src/activity-types/activity-types.checkers.ts:53

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isNonInteractive

● isNonInteractive: ActivityTypeChecker = anyPass([isAttempt, isNonInteractiveAttempt])

Defined in src/activity-types/activity-types.checkers.ts:237


<Const> isNonInteractiveAttempt

● isNonInteractiveAttempt: function = isActivityType(nonInteractiveTypes.nonInteractive)

Defined in src/activity-types/activity-types.checkers.ts:229

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isNonInteractiveRecipe

● isNonInteractiveRecipe: function = isRecipe(recipes.nonInteractive)

Defined in src/recipes/recipes.checkers.ts:35

Type declaration

▸(recipe: string): boolean

Parameters:

Name Type
recipe string

Returns: boolean


<Const> isOpenAnswer

● isOpenAnswer: ActivityTypeChecker = anyPass([ isAudioRecording, isDraw, isEssay, isGenericOpenAnswer, isUploadFile, isVideoRecording, isMathFormulae ])

Defined in src/activity-types/activity-types.checkers.ts:164


<Const> isOpenAnswerRecipe

● isOpenAnswerRecipe: function = isRecipe(recipes.openAnswer)

Defined in src/recipes/recipes.checkers.ts:15

Type declaration

▸(recipe: string): boolean

Parameters:

Name Type
recipe string

Returns: boolean


<Const> isOtherType

● isOtherType: ActivityTypeChecker = anyPass([isLikert, isQuiz, isPassword])

Defined in src/activity-types/activity-types.checkers.ts:281


<Const> isPassed

● isPassed: function = isVerbId(verbs.passed.id)

Defined in src/verbs/verb-ids.checkers.ts:24

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isPassedVerb

● isPassedVerb: function = isVerb(verbs.passed)

Defined in src/verbs/verbs.checkers.ts:24

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isPassword

● isPassword: function = isActivityType(otherTypes.password)

Defined in src/activity-types/activity-types.checkers.ts:272

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isPaused

● isPaused: function = isVerbId(verbs.paused.id)

Defined in src/verbs/verb-ids.checkers.ts:49

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isPausedVerb

● isPausedVerb: function = isVerb(verbs.paused)

Defined in src/verbs/verbs.checkers.ts:49

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isPlayed

● isPlayed: function = isVerbId(verbs.played.id)

Defined in src/verbs/verb-ids.checkers.ts:44

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isPlayedVerb

● isPlayedVerb: function = isVerb(verbs.played)

Defined in src/verbs/verbs.checkers.ts:44

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isPosted

● isPosted: function = isVerbId(verbs.posted.id)

Defined in src/verbs/verb-ids.checkers.ts:84

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isPostedVerb

● isPostedVerb: function = isVerb(verbs.posted)

Defined in src/verbs/verbs.checkers.ts:84

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isQuestion

● isQuestion: function = isActivityType(feedbackTypes.question)

Defined in src/activity-types/activity-types.checkers.ts:347

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isQuiz

● isQuiz: function = isActivityType(otherTypes.quiz)

Defined in src/activity-types/activity-types.checkers.ts:263

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isReplied

● isReplied: function = isVerbId(verbs.replied.id)

Defined in src/verbs/verb-ids.checkers.ts:89

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isRepliedVerb

● isRepliedVerb: function = isVerb(verbs.replied)

Defined in src/verbs/verbs.checkers.ts:89

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isReported

● isReported: function = isVerbId(verbs.reported.id)

Defined in src/verbs/verb-ids.checkers.ts:114

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isReportedVerb

● isReportedVerb: function = isVerb(verbs.reported)

Defined in src/verbs/verbs.checkers.ts:114

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isResponseInImage

● isResponseInImage: function = isActivityType(closedResponseTypes.responseInImage)

Defined in src/activity-types/activity-types.checkers.ts:83

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isReview

● isReview: function = isActivityType(feedbackTypes.review)

Defined in src/activity-types/activity-types.checkers.ts:352

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isScorm

● isScorm: ActivityTypeChecker = anyPass([ isScormGeneric, isScormChoice, isScormInlineChoice, isScormMultipleChoice, isScormTextEntry ])

Defined in src/activity-types/activity-types.checkers.ts:405


<Const> isScormChoice

● isScormChoice: function = isActivityType(scormTypes.choice)

Defined in src/activity-types/activity-types.checkers.ts:379

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isScormGeneric

● isScormGeneric: function = isActivityType(scormTypes.genericScorm)

Defined in src/activity-types/activity-types.checkers.ts:374

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isScormInlineChoice

● isScormInlineChoice: function = isActivityType(scormTypes.inlineChoice)

Defined in src/activity-types/activity-types.checkers.ts:389

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isScormMultipleChoice

● isScormMultipleChoice: function = isActivityType(scormTypes.multipleChoice)

Defined in src/activity-types/activity-types.checkers.ts:384

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isScormRecipe

● isScormRecipe: function = isRecipe(recipes.scorm)

Defined in src/recipes/recipes.checkers.ts:40

Type declaration

▸(recipe: string): boolean

Parameters:

Name Type
recipe string

Returns: boolean


<Const> isScormTextEntry

● isScormTextEntry: function = isActivityType(scormTypes.textEntry)

Defined in src/activity-types/activity-types.checkers.ts:394

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isSingleChoice

● isSingleChoice: function = isActivityType(closedResponseTypes.singleChoice)

Defined in src/activity-types/activity-types.checkers.ts:63

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isSkipped

● isSkipped: function = isVerbId(verbs.skipped.id)

Defined in src/verbs/verb-ids.checkers.ts:64

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isSkippedVerb

● isSkippedVerb: function = isVerb(verbs.skipped)

Defined in src/verbs/verbs.checkers.ts:64

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isSurvey

● isSurvey: function = isActivityType(feedbackTypes.survey)

Defined in src/activity-types/activity-types.checkers.ts:357

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isTerminated

● isTerminated: function = isVerbId(verbs.terminated.id)

Defined in src/verbs/verb-ids.checkers.ts:139

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isTerminatedVerb

● isTerminatedVerb: function = isVerb(verbs.terminated)

Defined in src/verbs/verbs.checkers.ts:139

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isUnit

● isUnit: function = isActivityType(bookTypes.unit)

Defined in src/activity-types/activity-types.checkers.ts:250

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isUploadFile

● isUploadFile: function = isActivityType(openAnswerTypes.uploadFile)

Defined in src/activity-types/activity-types.checkers.ts:146

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isVideo

● isVideo: function = isActivityType(audioVideoTypes.video)

Defined in src/activity-types/activity-types.checkers.ts:208

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isVideoRecording

● isVideoRecording: function = isActivityType(openAnswerTypes.videoRecording)

Defined in src/activity-types/activity-types.checkers.ts:151

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


<Const> isVotedDown

● isVotedDown: function = isVerbId(verbs.votedDown.id)

Defined in src/verbs/verb-ids.checkers.ts:109

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isVotedDownVerb

● isVotedDownVerb: function = isVerb(verbs.votedDown)

Defined in src/verbs/verbs.checkers.ts:109

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isVotedUp

● isVotedUp: function = isVerbId(verbs.votedUp.id)

Defined in src/verbs/verb-ids.checkers.ts:104

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isVotedUpVerb

● isVotedUpVerb: function = isVerb(verbs.votedUp)

Defined in src/verbs/verbs.checkers.ts:104

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isWatched

● isWatched: function = isVerbId(verbs.watched.id)

Defined in src/verbs/verb-ids.checkers.ts:59

Type declaration

▸(verbId: string): boolean

Parameters:

Name Type
verbId string

Returns: boolean


<Const> isWatchedVerb

● isWatchedVerb: function = isVerb(verbs.watched)

Defined in src/verbs/verbs.checkers.ts:59

Type declaration

▸<T>(verbId: T): boolean

Type parameters:

Parameters:

Name Type
verbId T

Returns: boolean


<Const> isWordsBank

● isWordsBank: function = isActivityType(closedResponseTypes.wordsBank)

Defined in src/activity-types/activity-types.checkers.ts:68

Type declaration

▸(activityType: string): boolean

Parameters:

Name Type
activityType string

Returns: boolean


Functions

<Private>``<Const> anyPass

anyPass(checks: Array<function>): (Anonymous function)

Defined in src/fp.ts:14

Parameters:

Name Type
checks Array<function>

Returns: (Anonymous function)


<Private>``<Const> equals

equals(expected: any): (Anonymous function)

Defined in src/fp.ts:6

Parameters:

Name Type
expected any

Returns: (Anonymous function)


<Private>``<Const> isActivityType

isActivityType(expectedType: string): ActivityTypeChecker

Defined in src/activity-types/activity-types.checkers.ts:21

Parameters:

Name Type
expectedType string

Returns: ActivityTypeChecker


<Const> isAssessable

isAssessable(activityType: string): boolean

Defined in src/activity-types/activity-types.checkers.ts:339

Parameters:

Name Type
activityType string

Returns: boolean


<Private>``<Const> isRecipe

isRecipe(expectedRecipe: string): RecipeChecker

Defined in src/recipes/recipes.checkers.ts:10

Parameters:

Name Type
expectedRecipe string

Returns: RecipeChecker


<Private>``<Const> isVerb

isVerb<T>(expectedVerb: T): VerbChecker

Defined in src/verbs/verbs.checkers.ts:9

Type parameters:

Parameters:

Name Type
expectedVerb T

Returns: VerbChecker


<Private>``<Const> isVerbId

isVerbId(expectedVerbId: string): VerbIdChecker

Defined in src/verbs/verb-ids.checkers.ts:9

Parameters:

Name Type
expectedVerbId string

Returns: VerbIdChecker


<Private>``<Const> propEq

propEq<T>(property: keyof T, value: any): (Anonymous function)

Defined in src/fp.ts:21

Type parameters:

T : object

Parameters:

Name Type
property keyof T
value any

Returns: (Anonymous function)


searchUrl

searchUrl(url: string, haystack: [], urlParts: string[]): string[]

Defined in src/functions/search-url.ts:1

Parameters:

Name Type
url string
haystack []
urlParts string[]

Returns: string[]


shortenUrls

shortenUrls(url: string): string

Defined in src/functions/shorten-urls.ts:4

Parameters:

Name Type
url string

Returns: string


Object literals

<Const> activityTypes

activityTypes: object

Defined in src/activity-types/activity-types.ts:96