Interface TwitterAction<TActionSchema>

Represents the base structure for Twitter (X) Actions.

interface TwitterAction<TActionSchema extends TwitterActionSchemaAny> {
    argsSchema: TActionSchema;
    description: string;
    func:
        | (client: TwitterApi, args: TypeOf<TActionSchema>) => Promise<string>
        | (args: TypeOf<TActionSchema>) => Promise<string>;
    name: string;
}

Type Parameters

TActionSchema extends TwitterActionSchemaAny

Implemented by

Index

Properties

argsSchema description func name

Properties

argsSchema

argsSchema: TActionSchema

Schema for validating action arguments

description

description: string

A description of what the action does

func

func:
| (client: TwitterApi, args: TypeOf<TActionSchema>) => Promise<string>
| (args: TypeOf<TActionSchema>) => Promise<string>

The function to execute for this action

name

name: string

The name of the action.