hartl3y94 / lundstrongorders-typescript

LundstrongOrders TS

Roblox-ts compatibility for working with the API.

Getting Started

Installation

Install through npm or yarn.

yarn add @rbxts/lundstrongorders

npm install @rbxts/lundstrongorders

Please note @rbxts/services is required as a peerDependency, although you should already have it.

Usage

An example is below. ordersAPI can be changed to any variable name you like, as it is the default export.

import ordersAPI from '@rbxts/lundstrongorders'
import { ReplicatedStorage } from '@rbxts/services'

let API = require(ReplicatedStorage.LundstrongOrders.API) as ordersAPI
API.onOrderClaimed.Connect((order) => {
    print(order.id)
})
API.SendNotification(plr, "hello this is sasial here!", 10)

Gotchas

The only 'gotcha' there is with this library, is that you DO NOT give order a type. The compiler will automatically give it the order type because of how the definitions were wrote.

- API.onOrderClaimed.Connect((order: Order) => {
+ API.onOrderClaimed.Connect((order) => {

Contributing

We love contributions! Pull requests are warmly welcomed and highly appriciated. For major changes, please open an issue first or discuss on the discord to let us know what you would like to change.

Support

Join the Lundstrong Discord.

License