gnss-auth/lib/message.interface.d.ts

Shared singleton authorization service for Angular MFE architecture

/**
 * An interface for message objects that are returned by CRUD operations or
 * other components.
 */
export interface MessageInterface {
    /**
     * A string that represents a message either from an HTTP response or a
     * component that will be displayed by a
     * [MessageDialog]{@link MessageDialog}
     */
    message: string;
    /**
     * The type of message returned from an HTTP response or a component. 'Success'
     * means the operation was successfully completed while 'error' means the
     * operation failed. The message that is displayed will address the success or
     * failure of the operation.
     */
    type: 'success' | 'error';
    /**
     * In some CRUD or component operations, the server or component will (ussually
     * in a 'successful' result) return an object that represents a newly created
     * or modified object that is the result of an operation. That object can be
     * accessed by the message's body attribute.
     */
    body?: any;
}