@neuxnet/neux-miniapp-types

TypeScript definitions for Neux MiniApp development.

This package provides editor autocomplete, inline documentation, and compile-time type checking for Neux MiniApp projects. It does not include a runtime or polyfill.

Installation

npm install --save-dev @neuxnet/neux-miniapp-types

Editor support

The package also publishes metadata/neux-html-data.json and metadata/neux-components.code-snippets, generated from the Neux component inventory. A Neux CLI starter copies these files into .vscode/: the HTML custom data enables built-in NXML tags and nx:* directives, while the snippets generate source-backed component templates with their declared properties and events.

Usage

Add the package to the types list in your tsconfig.json or jsconfig.json:

{
  "compilerOptions": {
    "types": ["@neuxnet/neux-miniapp-types"]
  }
}

You can then use TypeScript in your MiniApp code with type checking and autocomplete for APIs such as:

Page({
  data: {
    count: 0,
  },

  onLoad() {
    nx.showToast({
      title: `Count: ${this.data.count}`,
    })
  },
})

If you create a project with neux init, the CLI adds this package and the TypeScript configuration automatically.

Included definitions

• MiniApp globals: App, Page, Component, Behavior, and getApp
• Page and component data, properties, methods, lifecycle hooks, and events
• Neux MiniApp APIs exposed through wx and nx
• Built-in component properties and event payloads
• Type definitions for networking, storage, files, media, Canvas, maps, navigation, device features, Bluetooth, and other supported capabilities

The declarations are maintained against the Neux source code and describe the Neux MiniApp public API. They are not a replacement for platform capability checks or runtime documentation; API availability may vary by host platform.

License

MIT