Developer Documentation
Comprehensive guides, API references, and tutorials to help you leverage EGG NIPPS technologies effectively.
Getting Started
Installation
To install EGG NIPPS tools, use your preferred package manager:
npm install @eggnipsis/core
# or
yarn add @eggnipsis/core
Setup Guide
Initialize your project with our CLI tool to generate boilerplate:
eggnipps init my-project
cd my-project
npm start
Documentation Structure
- Quick Start: 15-minute guides for new users
- Advanced Topics: Deep dives into architecture concepts
- API Reference: Full type definitions and usage
API Reference
Core Module
`eggCore.init(options: Options): CoreInstance`
Creates a new instance of the EGG NIPPS SDK with configured options
Configuration
`config: {
- apiKey: string
- endpoint: string
- timeout: number
Examples
const eggnipCore = eggCore.init('prod');
eggnipCore.connect().then(() => {
// Your code here
});