Skip to content

SquashConsulting/shared

Repository files navigation

Shared Modules

Link This Service

This service provides "shared": "0.0.0", so to use it in your Foxx service you need to update your dependencies in manifest.json like so:

"dependencies": {
  /* ... */
  "shared": "shared:^0.0.0"
},

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

License

Copyright (c) 2020 Squash Consulting. All rights reserved.

About

Generic Models, Schemas, Interfaces, Collections shared among squash services

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published