feat(types): OS

Signed-off-by: Lexus Drumgold <[email protected]>

src/types/__tests__/os.spec-d.ts

@@ -0,0 +1,72 @@
+/**
+ * @file Unit Tests - OS
+ * @module pkg-types/types/tests/OS
+ */
+
+import type TestSubject from '../os'
+
+describe('unit:types/OS', () => {
+  it('should allow "aix"', () => {
+    assertType<TestSubject>('aix')
+  })
+
+  it('should allow "darwin"', () => {
+    assertType<TestSubject>('darwin')
+  })
+
+  it('should allow "freebsd"', () => {
+    assertType<TestSubject>('freebsd')
+  })
+
+  it('should allow "linux"', () => {
+    assertType<TestSubject>('linux')
+  })
+
+  it('should allow "openbsd"', () => {
+    assertType<TestSubject>('openbsd')
+  })
+
+  it('should allow "sunos"', () => {
+    assertType<TestSubject>('sunos')
+  })
+
+  it('should allow "ppc64"', () => {
+    assertType<TestSubject>('ppc64')
+  })
+
+  it('should allow "win32"', () => {
+    assertType<TestSubject>('win32')
+  })
+
+  it('should allow "!aix"', () => {
+    assertType<TestSubject>('!aix')
+  })
+
+  it('should allow "!darwin"', () => {
+    assertType<TestSubject>('!darwin')
+  })
+
+  it('should allow "!freebsd"', () => {
+    assertType<TestSubject>('!freebsd')
+  })
+
+  it('should allow "!linux"', () => {
+    assertType<TestSubject>('!linux')
+  })
+
+  it('should allow "!openbsd"', () => {
+    assertType<TestSubject>('!openbsd')
+  })
+
+  it('should allow "!sunos"', () => {
+    assertType<TestSubject>('!sunos')
+  })
+
+  it('should allow "!ppc64"', () => {
+    assertType<TestSubject>('!ppc64')
+  })
+
+  it('should allow "!win32"', () => {
+    assertType<TestSubject>('!win32')
+  })
+})

src/types/index.ts

@@ -8,6 +8,7 @@ export type { default as CPU } from './cpu'
 export type { default as Engine } from './engine'
 export type { default as ExportCondition } from './export-condition'
 export type { default as HoistingLimits } from './hoisiting-limits'
+export type { default as OS } from './os'
 export type { default as Registry } from './registry'
 export type { default as Type } from './type'
 export type { default as TypesVersions } from './types-versions'

src/types/os.ts

@@ -0,0 +1,25 @@
+/**
+ * @file Type Definitions - OS
+ * @module pkg-types/types/OS
+ */
+
+import type { EmptyString, LiteralUnion } from '@flex-development/tutils'
+
+/**
+ * Operating system platforms a package runs on.
+ *
+ * @see https://docs.npmjs.com/cli/configuring-npm/package-json#os
+ * @see https://yarnpkg.com/configuration/manifest#os
+ */
+type OS = LiteralUnion<
+  | `${EmptyString | '!'}aix`
+  | `${EmptyString | '!'}darwin`
+  | `${EmptyString | '!'}freebsd`
+  | `${EmptyString | '!'}linux`
+  | `${EmptyString | '!'}openbsd`
+  | `${EmptyString | '!'}sunos`
+  | `${EmptyString | '!'}win32`,
+  string
+>
+
+export type { OS as default }