@types/cfenv

Installation

npm install --save @types/cfenv

Summary

This package contains type definitions for cfenv (https://github.com/cloudfoundry-community/node-cfenv).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cfenv.

index.d.ts

export interface Service {
    label: string;
    name: string;
    plan: string;
    tags: string[];
    credentials: Record<string, any>;
}

export interface ApplicationConfig {
    name?: string;

    [rest: string]: any;
}

export interface ServicesConfig {
    [name: string]: Array<{
        credentials?: Record<string, any>;
        name?: string;

        [rest: string]: any;
    }>;
}

export interface AppEnv {
    app: Record<string, any>;
    isLocal: boolean;
    name: string;
    port: number;
    bind: string;
    urls: string[];
    url: string;
    services: Record<string, any>;

    toJSON: () => string;
    getServices: () => { [key: string]: Service };
    getService: (spec: string | RegExp) => Service | null;
    getServiceURL: (
        spec: string | RegExp,
        replacements?: Record<string, any>,
    ) => string | null;
    getServiceCreds: (spec: string | RegExp) => Record<string, any> | null;
}

export interface GetAppEnvOptions {
    name?: string;
    protocol?: string;
    vcap?: {
        application?: ApplicationConfig;
        services?: ServicesConfig;
    };
    vcapFile?: string;
}

export function getAppEnv(options?: GetAppEnvOptions): AppEnv;

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: none

Credits

These definitions were written by Jordan Adams.