Initialises block directories with each directory corresponding to a block class.
An object with keys as block classes and values as block directories.
Wrapper function that verifies a study plan against a specific block.
List of modules in the study plan.
Block directory which contains the desired block.
Identifier of the desired block.
An object representing the result of a study plan verification.
Generated using TypeDoc
This module provides functions that make up the main functionality of
planwithus-lib.A block is used to express course requirements. Blocks are loaded from the
blocks/directory of the repository root folder and arranged into classes, with each class forming a subdirectory of theblocks/directory. (For example, blocks under theprimaryclass can be found atblocks/primary.) Blocks are currently organised into three categories,primary(referring to primary majors),second(referring to second majors) andminor(referring to minors).Each block is represented by a YAML file which contains a single top-level block with an identifier corresponding to its filename. (For example, the block at
blocks/primary/cs-hons-2020.ymlis a primary major block with the identifiercs-hons-2020.) Beyond their classes, folder names are ignored; the two files atblocks/primary/cs-hons-2020.ymlandblocks/primary/cs-hons-2020/cs-hons-2020.ymlwill represent a primary major with the same identifiercs-hons-2020. Note that blocks with the same identifiers are prohibited.For more information on the specification format of blocks, please refer to the block module.