KeySignature - port to TypeScript #22
Conversation
There was a problem hiding this comment.
@meganindya Currently, this PR ports only a part of the file, so that its easier to go through line by line. Please have a look at the ported and original code and share your insights. I have also highlighted some points I was curious about. Thanks
|
Entire file ported, all the test cases are passing. Thanks
|
|
This is taking a while. I'm making a few changes on top. Converting to draft for now. |
Improve on the documentation (plus cosmetic changes) extensively. Add minor code improvements and corrections sparingly.
meganindya
changed the title
There was a problem hiding this comment.
@walterbender need some inputs.
Documentation required at some more places. I've marked the areas with a 'docs' comment.
On another note, there are 16 print statements in the Python code. I was thinking if we should use throw-try-catch error handling for those cases instead?
| 'ajam maqam': 'bb' | ||
| }; | ||
|
|
||
| static readonly MODE_MAPPER: { [key: string]: string } = { |
| key: string; | ||
| mode: string; | ||
| scale: string[]; | ||
| halfSteps: number[]; | ||
| keySignature: string; | ||
| genericScale: string[]; | ||
| scalarModeNumbers: string[]; | ||
| eastIndianSolfegeNotes: string[]; |
There was a problem hiding this comment.
Which of these should we expect to be directly accessed through the instance, and which are private?
Also need docs.
| private _scale: Scale; | ||
| private _noteNames: string[]; | ||
| private _fixedSolfege: boolean; | ||
| private _solfegeNotes: string[]; | ||
| private _customNoteNames: string[]; | ||
| private _numberOfSemitones: number; |
Add getters for public instance variables, add missing documentation, and make cosmetic improvements.
Reference #18
Ports
keysignature.pyto typescript.