@atomist/cortex/Status.ts

Atomist Cortex model TypeScript typings

/*
 * Copyright 2015-2017 Atomist Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { TreeNode, GraphNode, FormatInfo, PathExpressionEngine } from "@atomist/rug/tree/PathExpression";
import { ProjectContext } from "@atomist/rug/operations/ProjectEditor";
import { Commit } from "./Commit";
export { Status };

/**
 * Type Status
 */
interface Status extends GraphNode {

    /**
     * commit - Status -> Commit
     *
     * @property {Commit} commit
     */
    readonly commit: Commit;

    /**
     * context
     *
     * @property {string} context
     */
    readonly context: string;

    /**
     * description
     *
     * @property {string} description
     */
    readonly description: string;

    /**
     * state
     *
     * @property {"pending" | "success" | "error" | "failure"} state
     */
    readonly state: "pending" | "success" | "error" | "failure";

    /**
     * targetUrl
     *
     * @property {string} targetUrl
     */
    readonly targetUrl: string;

}