Options
All
  • Public
  • Public/Protected
  • All
Menu

Module foxx-manifest

import type { FoxxManifest } from "arangojs/foxx-manifest";

The "foxx-manifest" module provides the Foxx manifest type for TypeScript.

Generated from JSON Schema using json-schema-to-typescript.

Index

Type aliases

Type aliases

Configuration

Configuration: { default?: any; description?: string; required?: boolean; type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool" }

A configuration option.

Type declaration

  • Optional default?: any

    The default value for this option in plain JSON. Can be omitted to provide no default value.

  • Optional description?: string

    A human-readable description of the option.

  • Optional required?: boolean

    Whether the service can not function without this option. Defaults to true unless a default value is provided.

  • type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool"

    The type of value expected for this option.

Dependency

Dependency: { description?: string; multiple?: boolean; name?: string; required?: boolean; version?: string }

A service dependency.

Type declaration

  • Optional description?: string

    A description of how the API is used or why it is needed.

  • Optional multiple?: boolean

    Whether the dependency can be specified more than once.

  • Optional name?: string

    Name of the API the service expects.

  • Optional required?: boolean

    Whether the service can not function without this dependency.

  • Optional version?: string

    The semantic version ranges of the API the service expects.

File

File: { gzip?: boolean; path: string; type?: string }

A service file asset.

Type declaration

  • Optional gzip?: boolean

    If set to true the file will be served with gzip-encoding if supported by the client. This can be useful when serving text files like client-side JavaScript, CSS or HTML.

  • path: string

    Relative path of the file or folder within the service.

  • Optional type?: string

    The MIME content type of the file. Defaults to an intelligent guess based on the filename's extension.

FoxxManifest

FoxxManifest: { author?: string; configuration?: Dict<Configuration>; contributors?: string[]; defaultDocument?: string; dependencies?: Dict<string | Dependency>; description?: string; engines?: Dict<string> & { arangodb?: string }; files?: Dict<string | File>; keywords?: string[]; lib?: string; license?: string; main?: string; name?: string; provides?: Dict<string>; scripts?: Dict<string>; tests?: string | string[]; thumbnail?: string; version?: string }

Schema for ArangoDB Foxx service manifests.

Type declaration

  • Optional author?: string

    The full name of the author of the service (i.e. you). This will be shown in the web interface.

  • Optional configuration?: Dict<Configuration>

    An object defining the configuration options this service requires.

  • Optional contributors?: string[]

    A list of names of people that have contributed to the development of the service in some way. This will be shown in the web interface.

  • Optional defaultDocument?: string

    If specified, the / (root) route of the service will automatically redirect to the given relative path, e.g. "index.html".

  • Optional dependencies?: Dict<string | Dependency>

    The dependencies this service uses, i.e. which APIs its dependencies need to be compatible with.

  • Optional description?: string

    A human-readable description of the service. This will be shown in the web interface.

  • Optional engines?: Dict<string> & { arangodb?: string }

    An object indicating the semantic version ranges of ArangoDB (or compatible environments) the service will be compatible with.

  • Optional files?: Dict<string | File>

    An object defining file assets served by this service.

  • Optional keywords?: string[]

    A list of keywords that help categorize this service. This is used by the Foxx Store installers to organize services.

  • Optional lib?: string

    The relative path to the Foxx JavaScript files in the service, e.g. "lib". Defaults to the folder containing this manifest.

  • Optional license?: string

    A string identifying the license under which the service is published, ideally in the form of an SPDX license identifier. This will be shown in the web interface.

  • Optional main?: string

    The relative path to the main entry point of this service (relative to lib), e.g. "index.js".

  • Optional name?: string

    The name of the Foxx service. This will be shown in the web interface.

  • Optional provides?: Dict<string>

    The dependencies this provides, i.e. which APIs it claims to be compatible with.

  • Optional scripts?: Dict<string>

    An object defining named scripts provided by this service, which can either be used directly or as queued jobs by other services.

  • Optional tests?: string | string[]

    A path/pattern or list of paths/patterns of JavaScript tests provided for this service.

  • Optional thumbnail?: string

    The filename of a thumbnail that will be used alongside the service in the web interface. This should be a JPEG or PNG image that looks good at sizes 50x50 and 160x160.

  • Optional version?: string

    The version number of the Foxx service. The version number must follow the semantic versioning format. This will be shown in the web interface.

Generated using TypeDoc