@atomist/sdm/src/lib/api/mapping/support/StaticPushMapping.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2018 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 { PushMapping } from "../PushMapping";
import { PushTest } from "../PushTest";

/**
 * PushMapping that always returns the same value, guarded by a PushTest.
 * Return undefined if the PushTest doesn't match.
 */
export interface StaticPushMapping<V> extends PushMapping<V> {

    readonly pushTest: PushTest;

    /**
     * Value we always return
     */
    readonly value: V;
}