Skip to content

ArangoDB Foxx Service Template with TypeScript & Yarn 2.0 Support

License

Notifications You must be signed in to change notification settings

SquashConsulting/foxx_typescript

Repository files navigation

Foxx TypeScript Service Template

Update: The next version of the template is being developed on the next branch. It will support npm, as we decided to drop support for yarn 2.0, because of some unexpected behaivours. This template will be part of the kaliningrad project. Backwards compatability will be maintained, however, the usage of the template is encoureged through the kaliningrad's generator. Please note, you will still be able to use this as a standalone template.

Install packages

yarn install

Note: this projcet uses yarn version >= 2.0, and follows the Zero Install ideology. Follow this link for more information.

Install/Upgrade Foxx Service

In order to use the typescript service in ArangoDB, you need to run yarn build and then do foxx {install,upgrade} <mount> --server <server_name> --database <db_name>

Editor configuration

yarn@berry which is used in this project does not use node_modules. Because of this, some editors won't recognize imported modules. Run this command to resolve the issue in VSCode.

yarn config:editor

In VSCode you also need to explicitly specify the version of TypeScript to use.

  1. Press {CTRL,CMD}+SHIFT+P in a TypeScript file

  2. Choose "Select TypeScript Version"

  3. Pick "Use Workspace Version"

More info here

Releases

No releases published

Packages

No packages published