Correxit API / Browser / Assignment

Assignment¶

Utilities for preparing and issuing serialized notebook assignments.

Type Aliases¶

Assigned¶

Assigned = object

Defined in: src/correxit/assignment.ts:12

Properties¶

encrypted¶

encrypted: string[]

Defined in: src/correxit/assignment.ts:13

identifier¶

identifier: Assigned

Defined in: src/correxit/assignment.ts:14

notebook¶

notebook: INotebookContent

Defined in: src/correxit/assignment.ts:15

resources¶

resources: string[] | null

Defined in: src/correxit/assignment.ts:16

Issue¶

Issue = object

Defined in: src/correxit/assignment.ts:37

Properties¶

assignee¶

assignee: string

Defined in: src/correxit/assignment.ts:38

author¶

author: string

Defined in: src/correxit/assignment.ts:39

distribution¶

distribution: number | null

Defined in: src/correxit/assignment.ts:40

file¶

file: string

Defined in: src/correxit/assignment.ts:41

key¶

key: string

Defined in: src/correxit/assignment.ts:42

notebook¶

notebook: INotebookContent

Defined in: src/correxit/assignment.ts:43

roster¶

roster: string[]

Defined in: src/correxit/assignment.ts:44

Issued¶

Issued = object

Defined in: src/correxit/assignment.ts:32

Properties¶

identifier¶

identifier: Assigned

Defined in: src/correxit/assignment.ts:33

notebook¶

notebook: INotebookContent

Defined in: src/correxit/assignment.ts:34

Options¶

Options = object & Secret

Defined in: src/correxit/assignment.ts:19

Type Declaration¶

assignee¶

assignee: string

distribution?¶

optional distribution?: number | null

file?¶

optional file?: string | null

notebook¶

notebook: INotebookContent

roster?¶

optional roster?: string[] | null

Prepared¶

Prepared = object

Defined in: src/correxit/assignment.ts:27

Properties¶

encrypted¶

encrypted: string[]

Defined in: src/correxit/assignment.ts:28

notebook¶

notebook: INotebookContent

Defined in: src/correxit/assignment.ts:29

Functions¶

assign()¶

assign(options): Promise\<Assigned>

Defined in: src/correxit/assignment.ts:48

Assign a serialized workbook to one assignee.

Parameters¶

Parameter	Type
`options`	`Options`

Returns¶

Promise\<Assigned>

authenticate()¶

authenticate(notebook, rubric): Promise\<void>

Defined in: src/correxit/assignment.ts:194

Authenticate issued grading contents without treating student answers as fixed.

Parameters¶

Parameter	Type
`notebook`	`INotebookContent`
`rubric`	`Unlocked`

Returns¶

Promise\<void>

filename()¶

filename(assignment, assignee): Promise\<string>

Defined in: src/correxit/assignment.ts:82

Parameters¶

Parameter	Type
`assignment`	`string`
`assignee`	`string`

Returns¶

Promise\<string>

a deterministic filename for an assigned workbook.

issue()¶

issue(options): Promise\<Issued>

Defined in: src/correxit/assignment.ts:90

Issue a prepared serialized workbook to one assignee.

Parameters¶

Parameter	Type
`options`	`Issue`

Returns¶

Promise\<Issued>

prepare()¶

prepare(source, rubric): Promise\<Prepared>

Defined in: src/correxit/assignment.ts:172

Prepare a serialized notebook as a reusable assignment template.

Parameters¶

Parameter	Type
`source`	`INotebookContent`
`rubric`	`Unlocked`

Returns¶

Promise\<Prepared>

stamp()¶

stamp(notebook, distribution): void

Defined in: src/correxit/assignment.ts:210

Stamp the distribution timestamp on a serialized notebook.

Parameters¶

Parameter	Type
`notebook`	`INotebookContent`
`distribution`	`number` \| `null`

Returns¶

void