@atomist/sdm/src/lib/api/mapping/PushMapping.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2019 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 {
    goals,
    Goals,
} from "../goal/Goals";
import { PushListenerInvocation } from "../listener/PushListener";
import { Mapping } from "./Mapping";

/**
 * Constant to indicate we should never match.
 * @type {any}
 */
export const DoNotSetAnyGoals: Goals = goals("no goals");

/**
 * Should be used in additive goal setting when no more goals should be scheduled.
 */
export const DoNotSetAnyGoalsAndLock: Goals = DoNotSetAnyGoals.andLock();

/**
 * Mapper from push to value, id it can be resolved.
 * This is a central interface used throughout the SDM.
 */
export interface PushMapping<V> extends Mapping<PushListenerInvocation, V> {

}