@atomist/cortex/GitHubProvider.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";

export { GitHubProvider };

/**
 * Type GitHubProvider
 */
interface GitHubProvider extends GraphNode {

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

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

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

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

}