rocketmq-client-nodejs
Version:
RocketMQ Node.js Client
56 lines (55 loc) • 2.08 kB
TypeScript
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
/**
* Consume result for push consumer.
*
* <p>Designed for push consumer specifically. This is a class-based result
* (matching the Java client) so that it can be extended with suspend results.</p>
*/
export declare class ConsumeResult {
/**
* Consume message successfully.
*/
static readonly SUCCESS: ConsumeResult;
/**
* Failed to consume message.
*/
static readonly FAILURE: ConsumeResult;
readonly name: string;
protected constructor(name: string);
toString(): string;
}
/**
* Suspend consume result.
*
* <p>When returned by the message listener, the consumer will suspend
* consumption of the current message (and related messages in FIFO mode)
* for the specified duration by changing the invisible duration.</p>
*/
export declare class ConsumeResultSuspend extends ConsumeResult {
readonly suspendTimeMs: number;
private constructor();
/**
* Create a suspend result with the given suspend time in milliseconds.
*
* @param suspendTimeMs - Suspend time in milliseconds
* @return {ConsumeResultSuspend} ConsumeResultSuspend instance
* @throws {Error} if suspendTimeMs is less than 50ms
*/
static of(suspendTimeMs: number): ConsumeResultSuspend;
toString(): string;
}