Skip to content

Num.Degrees

Num / Degrees

Import

typescript
import { Num } from '@wollybeard/kit'

// Access via namespace
Num.Degrees.someFunction()
typescript
import * as Num from '@wollybeard/kit/num'

// Access via namespace
Num.Degrees.someFunction()

Functions

[F] is

typescript
(value: unknown): boolean

Type predicate to check if value is a valid degree angle. Note: Any finite number can represent an angle in degrees.

[F] from

typescript
(value: number): number & { [DegreesBrand]: true; } & { [FiniteBrand]: true; }

Construct a Degrees angle. Throws if the value is not finite.

[F] tryFrom

typescript
(value: number): (number & { [DegreesBrand]: true; } & { [FiniteBrand]: true; }) | null

Try to construct a Degrees angle. Returns null if the value is not finite.

[F] fromRadians

typescript
(radians: number): number & { [DegreesBrand]: true; } & { [FiniteBrand]: true; }

Convert radians to degrees.

[F] toRadians

typescript
(deg: Degrees): number

Convert degrees to radians.

[F] normalize

typescript
(deg: Degrees): number & { [DegreesBrand]: true; } & { [FiniteBrand]: true; }

Normalize degrees to the range [0, 360).

Types

[∩] Degrees

typescript
type Degrees = number & { [DegreesBrand]: true }

Angle in degrees.