Package Exports

@mitodl/course-search-utils
@mitodl/course-search-utils/dist/index.js
@mitodl/course-search-utils/dist/url_utils
@mitodl/course-search-utils/dist/url_utils.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mitodl/course-search-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Course Search Utils

This repo holds the core logic for our learning resource search. The basic API is a React hook (useCourseSearch) which provides for deserializing the params from the URL, managing the internal state of which facets are selected, etc.

development

run the tests:

npm run test
npm run test:watch # for watch mode

run the typechecker:

npm run typecheck

publishing

to publish a new version, open a PR with your changes and, once that is merged, check out the latest commit locally and do the following:

npm version x.x.x # increment this from the previous version appropriately
npm publish
git push origin # npm writes a version increment commit
git push --tags # and it tags it too