npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tarantoolscript

v0.32.0

Published

TypeScript definitions for Tarantool Lua API.

Downloads

2,344

Readme

TarantoolScript

TarantoolScript is a tool to help you create Tarantool Lua scripts using TypeScript.

Getting started

To install Tarantoolscript add tarantoolscript npm package to your TypeScript project:

$ npm install --save-dev tarantoolscript

Also to compile your TypeScript program to Lua scripts, you need to install TypeScriptToLua:

$ npm install --save-dev typescript-to-lua

Here you can find more information about TypeScriptToLua.

Usage

Tarantoolscript provides some type declarations useful to create you own Lua scripts which may be executed by Tarantool. Here you can find more information about Tarantool.

Basic usage

Init instance

Interface Box describes all functions and submodules, included into Tarantool global variable box. To use it, just declare constant box of type Box:

import { Box, ConfigOptions } from 'tarantoolscript';

declare const box: Box;

const cfg: ConfigOptions = {
    listen: 3301,
};

box.cfg(cfg);

TypeScriptToLua will compile this TypeScript code to following Lua code:

local ____exports = {}
local cfg = {listen = 3301}
box.cfg(cfg)
return ____exports

Create space

const bands = box.schema.space.create('bands');

Format space

bands.format([
    { name: 'id', type: 'unsigned' },
    { name: 'band_name', type: 'string' },
    { name: 'year', type: 'unsigned' },
]);

Create index

bands.create_index('primary', { parts: ['id'] });

Insert data

bands.insert([1, 'Roxette', 1986]);

Tarantool modules usage

To usage some modules, which should be imported into script with Lua keyword require, you need first edit your tsconfig.json by following algorithm. At example, if you need to import module log, add it to tsconfig compilerOptions.paths:

{
    "compilerOptions": {
        "paths": {
            "log": ["tarantoolscript/src/log.d.ts"]
        }
    },
    "tstl": {
        "noResolvePaths": [
            "log"
        ]
    }
}

Or for module luatest.helpers:

{
    "compilerOptions": {
        "paths": {
            "luatest.helpers": ["tarantoolscript/src/luatest.helpers.d.ts"]
        }
    },
    "tstl": {
        "noResolvePaths": [
            "luatest.helpers"
        ]
    }
}

Now you can import and use these modules:

import * as log from 'log';
import * as luatest_helpers from 'luatest.helpers';

log.info(luatest_helpers.uuid(1, 2, 3));

After compilation:

local ____exports = {}
local log = require("log")
local luatest_helpers = require("luatest.helpers")
log.info(luatest_helpers.uuid(1, 2, 3))
return ____exports

Of course, to use luatest package or other packages which not included into Tarantool default build, you need to install them with tt rocks command.

More usage examples

This repository contains many useful samples, which are examples of using modules taken from the official Tarantool documentation. Every source file contains in its header link to the corresponding documentation page.

This repository can help you understanding how to write Tarantool scripts with TarantoolScript.

Status

Tarantoolscript is under development and not declares many useful Tarantool modules, which will be added in the near future.

Feel free to add Issue or create Pull request.