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:40

Properties¶

assignee¶

assignee: string

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

author¶

author: string

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

distribution¶

distribution: number | null

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

file¶

file: string

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

key¶

key: string

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

notebook¶

notebook: INotebookContent

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

roster¶

roster: string[]

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

Issued¶

Issued = object

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

Properties¶

identifier¶

identifier: Assigned

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

notebook¶

notebook: INotebookContent

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

Options¶

Options = object & { key: string; passphrase: null; } | { key: null; passphrase: string; }

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:30

Properties¶

encrypted¶

encrypted: string[]

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

notebook¶

notebook: INotebookContent

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

Functions¶

assign()¶

assign(options): Promise\<Assigned>

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

Assign a serialized workbook to one assignee.

Parameters¶

Parameter	Type
`options`	`Options`

Returns¶

Promise\<Assigned>

filename()¶

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

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

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:93

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:193

Stamp the distribution timestamp on a serialized notebook.

Parameters¶

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

Returns¶

void