Skip to main content

Delete

The Delete class provides a convenient way to delete objects from S3.

Extends​

This class extends the abstract Action class from Core.

Methods​

performAs​

public async performAs(actor: Actor): Promise<any>;
  • Description: Delete an object from S3.
  • Parameters:
    • actor - The actor performing the action.
  • Returns: Promise<any> - The response object.

object​

Introduced in: 1.0.0

public static object(deleteObjectCommandInput): Delete;
  • Description: Create a new instance of the Delete class with the specified stream and options.
  • Parameters:
    • deleteObjectCommandInput - The DeleteObjectCommandInput object
  • Returns: Delete - A new instance of the Delete class.

Usage:

await actor.attemptsTo(
    Delete.object(deleteObjectCommandInput),
);

Methods inherited from Core Action​

orSkipOnFail​

Introduced in core: 0.5.0

public get orSkipOnFail(): Action;
  • Description: Allows to skip an action on fail.
  • Returns: Action - Returns the current action.

Usage:

// Would skip the step on error without breaking the execution
await actor.attemptsTo(
    Do.something().orSkipOnFail,
);

withAbilityAlias​

Introduced in core: 0.3.0

public withAbilityAlias(alias: string): Action;
  • Description: Defines the ability alias to be used during execution.
  • Parameters:
    • alias - The alias.
  • Returns: Action - Returns the current action.

Usage:

await actor.attemptsTo(
    Do.something().withAbilityAlias('myAlias'),
);