Last updated on October 23, 2026
Types for your functions
Write a declaration file so your editor checks your functions' names, inputs and outputs.
This command is in the TypeScript package only. The Ruby gem and the Python package do not have it.
What it does
One command writes a declaration file into your project describing your functions, by platform: their names, the shape of their input and the shape of their output. After that:
runautocompletes the function names- a wrong or missing input field is flagged in the editor
outputhas the function's declared type
The file describes the actions you can run the same way, for actions.run.
Write the file
Run the command
npx appnigma typesIt reads your key from APPNIGMA_SDK_KEY, or from --key. With a wrong key it says so and writes nothing.
Include the file
It writes appnigma-functions.d.ts in the current folder, or wherever --out says. Make sure that file is inside your tsconfig.json's include.
Run it again when a function goes live
The file only knows the functions that were live when it was written.
| Option | Meaning |
|---|---|
--key | Your SDK key. Defaults to APPNIGMA_SDK_KEY. |
--out | Where to write the file. |
--help | Shows the usage. |
What the file changes
The file adds types to this package, so nothing else changes. A function that went live after the file was written can still be called: an unknown name is accepted with any JSON object as its input.