Namespace: PitchClass

Interfaces

• PitchClassBrand

References

fromMnn

Renames and re-exports pc

---

ic

Renames and re-exports between

Type Aliases

PitchClass

Ƭ PitchClass: Shape & PitchClassBrand

Integer notation of pitch class

See

https://en.wikipedia.org/wiki/Pitch_class

Defined in

internal/PitchClass.ts:18

---

Shape

Ƭ Shape: RangedNat<typeof min, typeof max>

Defined in

internal/PitchClass.ts:6

Variables

ALL

• Const ALL: readonly PitchClass[]

Defined in

internal/PitchClass.ts:34

---

MAX

• Const MAX: 11 & PitchClassBrand

Defined in

internal/PitchClass.ts:33

---

MIN

• Const MIN: 0 & PitchClassBrand

Defined in

internal/PitchClass.ts:32

Functions

from

▸ from(v): PitchClass

Parameters

Name	Type
v	0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11

Returns

PitchClass

Defined in

internal/PitchClass.ts:24

---

fromIntClamp

▸ fromIntClamp(v): PitchClass

Parameters

Name	Type
v	Int

Returns

PitchClass

Defined in

internal/PitchClass.ts:26

---

fromIntMod

▸ fromIntMod(v): PitchClass

Parameters

Name	Type
v	Int

Returns

PitchClass

Defined in

internal/PitchClass.ts:27

---

fromNum

▸ fromNum(v): PitchClass

Parameters

Name	Type
v	number

Returns

PitchClass

Defined in

internal/PitchClass.ts:25

---

fromUnknown

▸ fromUnknown(v): PitchClass

Parameters

Name	Type
v	unknown

Returns

PitchClass

Defined in

internal/PitchClass.ts:28

---

hasShape

▸ hasShape<T>(v): v is T & (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11)

Type parameters

Name
T

Parameters

Name	Type
v	T

Returns

v is T & (0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11)

Defined in

internal/PitchClass.ts:7

---

invert

▸ invert(v, index?): PitchClass

Parameters

Name	Type	Default value
v	PitchClass	undefined
index	0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11	0

Returns

PitchClass

Defined in

internal/PitchClass.ts:36

---

mark

▸ mark(_v): _v is PitchClass

Parameters

Name	Type
_v	0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11

Returns

_v is PitchClass

Defined in

internal/PitchClass.ts:20

---

markNum

▸ markNum(v): v is PitchClass

Parameters

Name	Type
v	number

Returns

v is PitchClass

Defined in

internal/PitchClass.ts:21

---

markUnknown

▸ markUnknown(v): v is PitchClass

Parameters

Name	Type
v	unknown

Returns

v is PitchClass

Defined in

internal/PitchClass.ts:22

---

pic

▸ pic(from, to): PitchIntervalClass

Parameters

Name	Type
from	PitchClass
to	PitchClass

Returns

PitchIntervalClass

Defined in

internal/conversion.ts:41

---

transpose

▸ transpose(value, interval): PitchClass

Parameters

Name	Type
value	PitchClass
interval	PitchIntervalClass

Returns

PitchClass

Defined in

internal/conversion.ts:30