feat(types): Browser

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

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

@@ -0,0 +1,23 @@
+/**
+ * @file Unit Tests - Browser
+ * @module pkg-types/types/tests/Browser
+ */
+
+import type TestSubject from '../browser'
+
+describe('unit:types/Browser', () => {
+  it('should allow dependency map', () => {
+    assertType<TestSubject>({
+      fs: false,
+      path: './dist/browser-shims/path.mjs'
+    })
+  })
+
+  it('should allow empty object', () => {
+    assertType<TestSubject>({})
+  })
+
+  it('should allow path to file', () => {
+    assertType<TestSubject>('./dist/browser.mjs')
+  })
+})

src/types/browser.ts

@@ -0,0 +1,17 @@
+/**
+ * @file Type Definitions - Browser
+ * @module pkg-types/types/Browser
+ */
+
+import type DependencyMap from './dependency-map'
+
+/**
+ * Hint to JavaScript bundlers or component tools when packaging modules for
+ * client side use.
+ *
+ * @see https://docs.npmjs.com/cli/configuring-npm/package-json#browser
+ * @see https://yarnpkg.com/configuration/manifest#publishConfig.browser
+ */
+type Browser = DependencyMap<string | false> | string
+
+export type { Browser as default }

src/types/index.ts

@@ -5,6 +5,7 @@
 
 export type { default as Access } from './access'
 export type { default as Bin } from './bin'
+export type { default as Browser } from './browser'
 export type { default as CPU } from './cpu'
 export type { default as DependencyMap } from './dependency-map'
 export type { default as Engine } from './engine'