dappnode / types

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

@dappnode/types

This package provides a shared collection of TypeScript types, utility functions, parameters, and JSON schemas for DAppNode projects.

Installation

To add this package as a dependency in your project, use the following command:

npm install @dappnode/types

Usage

To utilize the shared types, utility functions, parameters, and JSON schemas in your project, simply import them as needed:

import { MyType, myUtilityFunction, myParameter } from "@dappnode/types";

Structure

This package is organized as follows:

  • src/types: Contains the shared TypeScript types.
  • src/utils: Contains the shared utility functions.
  • src/params: Contains the shared parameters.
  • src/schemas: Contains the shared JSON schemas.

Contributing

  1. Fork the repository and clone it to your local machine.

  2. Navigate to the project directory and install the dependencies:

    npm install
    
  3. Make your changes or additions to the code.

  4. Build the project:

    npm run build
    
  5. Commit and push your changes to your fork.

  6. Open a pull request to the main repository.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

About

License:GNU General Public License v3.0


Languages

Language:TypeScript 98.2%Language:JavaScript 1.8%