bf6-portal-mod-types 1.1.3-docs.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +25 -0
  2. package/index.d.ts +25672 -0
  3. package/package.json +57 -0
package/README.md ADDED
@@ -0,0 +1,25 @@
1
+ # bf6-portal-mod-types
2
+
3
+ TypeScript definitions for the Battlefield 6 Portal `mod` namespace.
4
+
5
+ ## Overview
6
+
7
+ This npm package provides TypeScript type definitions for the Battlefield 6 Portal `mod` namespace, enabling type-safe
8
+ development when building Portal experiences.
9
+
10
+ ## Source
11
+
12
+ The types in this package come directly from the SDK package downloadable at
13
+ [https://portal.battlefield.com/bf6/experiences](https://portal.battlefield.com/bf6/experiences), with additional or
14
+ cleaned up comments and documentation added for improved developer experience.
15
+
16
+ ## Installation
17
+
18
+ ```bash
19
+ npm -D install bf6-portal-mod-types
20
+ ```
21
+
22
+ ## Usage
23
+
24
+ The types are automatically available when you import or reference this package. The main type definitions are exported
25
+ from `index.d.ts`.