Saltearse al contenido

Creando Encuestas

En Seyfert, la capacidad de crear encuestas está a la vuelta de la esquina!
Esta sección mostrará la creación básica de encuestas, eventos y ejemplos.

Esta es una sección ampliada del archivo de configuración.

seyfert.config.mjs
export default config.bot({
//... otras opciones
intents: ['GuildMessagePolls', 'DirectMessagePolls'],
});

Recepción de eventos

Actualmente hay 2 eventos para las encuestas: messagePollVoteAdd y messagePollVoteRemove.

addVote.ts
import {
function createEvent<E extends ClientNameEvents | CustomEventsKeys>(data: {
data: {
name: E;
once?: boolean;
};
run: (...args: ResolveEventParams<E>) => any;
}): {
data: {
name: E;
once?: boolean;
};
run: (...args: ResolveEventParams<E>) => any;
}

Creates an event with the specified data and run function.

@paramdata - The event data.

@returnsThe created event.

@example const myEvent = createEvent({ data: { name: 'ready', once: true }, run: (user, client, shard) => { client.logger.info(Start ${user.username} on shard #${shard}); } });

createEvent
} from 'seyfert';
export default
createEvent<"messagePollVoteAdd">(data: {
data: {
name: "messagePollVoteAdd";
once?: boolean;
};
run: (args_0: {
userId: string;
channelId: string;
messageId: string;
guildId?: string | undefined;
answerId: number;
}, args_1: UsingClient, args_2: number) => any;
}): {
...;
}

Creates an event with the specified data and run function.

@paramdata - The event data.

@returnsThe created event.

@example const myEvent = createEvent({ data: { name: 'ready', once: true }, run: (user, client, shard) => { client.logger.info(Start ${user.username} on shard #${shard}); } });

createEvent
({
data: {
name: "messagePollVoteAdd";
once?: boolean;
}
data
: {
name: "messagePollVoteAdd"
name
: 'messagePollVoteAdd' },
run: (args_0: {
userId: string;
channelId: string;
messageId: string;
guildId?: string | undefined;
answerId: number;
}, args_1: UsingClient, args_2: number) => any
run
: (
data: {
userId: string;
channelId: string;
messageId: string;
guildId?: string | undefined;
answerId: number;
}
data
) => {
// Puedes hacer lo que quieras con los datos
var console: Console

The console module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers.

The module exports two specific components:

  • A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
  • A global console instance configured to write to process.stdout and process.stderr. The global console can be used without importing the node:console module.

Warning: The global console object's methods are neither consistently synchronous like the browser APIs they resemble, nor are they consistently asynchronous like all other Node.js streams. See the note on process I/O for more information.

Example using the global console:

console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
// Error: Whoops, something bad happened
// at [eval]:5:15
// at Script.runInThisContext (node:vm:132:18)
// at Object.runInThisContext (node:vm:309:38)
// at node:internal/process/execution:77:19
// at [eval]-wrapper:6:22
// at evalScript (node:internal/process/execution:76:60)
// at node:internal/main/eval_string:23:3
const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr

Example using the Console class:

const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);
myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err
const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err

@seesource

console
.
Console.log(message?: any, ...optionalParams: any[]): void

Prints to stdout with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).

const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout

See util.format() for more information.

@sincev0.1.100

log
(`The user: ${
data: {
userId: string;
channelId: string;
messageId: string;
guildId?: string | undefined;
answerId: number;
}
data
.
userId: string
userId
} added a vote to the poll: ${
data: {
userId: string;
channelId: string;
messageId: string;
guildId?: string | undefined;
answerId: number;
}
data
.
messageId: string
messageId
}`);
},
});

Fin del evento

La forma de comprobar cuándo finaliza una encuesta es utilizando el evento messageUpdate.

He aquí un ejemplo rápido que editará el mensaje cuando se complete una encuesta:

messageUpdate.ts
import {
function createEvent<E extends ClientNameEvents | CustomEventsKeys>(data: {
data: {
name: E;
once?: boolean;
};
run: (...args: ResolveEventParams<E>) => any;
}): {
data: {
name: E;
once?: boolean;
};
run: (...args: ResolveEventParams<E>) => any;
}

Creates an event with the specified data and run function.

@paramdata - The event data.

@returnsThe created event.

@example const myEvent = createEvent({ data: { name: 'ready', once: true }, run: (user, client, shard) => { client.logger.info(Start ${user.username} on shard #${shard}); } });

createEvent
} from 'seyfert';
export default
createEvent<"messageUpdate">(data: {
data: {
name: "messageUpdate";
once?: boolean;
};
run: (args_0: [message: Omit<Message, "tts"> & {
tts: false;
}, old: Message | undefined], args_1: UsingClient, args_2: number) => any;
}): {
...;
}

Creates an event with the specified data and run function.

@paramdata - The event data.

@returnsThe created event.

@example const myEvent = createEvent({ data: { name: 'ready', once: true }, run: (user, client, shard) => { client.logger.info(Start ${user.username} on shard #${shard}); } });

createEvent
({
data: {
name: "messageUpdate";
once?: boolean;
}
data
: {
name: "messageUpdate"
name
: 'messageUpdate' },
// Esto es [newMessage, oldMessage]
// Pero en este ejemplo sólo necesitamos newMessage
run: (args_0: [message: Omit<Message, "tts"> & {
tts: false;
}, old: Message | undefined], args_1: UsingClient, args_2: number) => any
run
: ([
newMessage: Omit<Message, "tts"> & {
tts: false;
}
newMessage
]) => {
if (
newMessage: Omit<Message, "tts"> & {
tts: false;
}
newMessage
.
poll?: Poll | undefined
poll
?.
results?: {
isFinalized: boolean;
answerCounts: {
id: number;
count: number;
meVoted: boolean;
}[];
} | undefined
results
?.
isFinalized: boolean | undefined
isFinalized
) {
var console: Console

The console module provides a simple debugging console that is similar to the JavaScript console mechanism provided by web browsers.

The module exports two specific components:

  • A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
  • A global console instance configured to write to process.stdout and process.stderr. The global console can be used without importing the node:console module.

Warning: The global console object's methods are neither consistently synchronous like the browser APIs they resemble, nor are they consistently asynchronous like all other Node.js streams. See the note on process I/O for more information.

Example using the global console:

console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
// Error: Whoops, something bad happened
// at [eval]:5:15
// at Script.runInThisContext (node:vm:132:18)
// at Object.runInThisContext (node:vm:309:38)
// at node:internal/process/execution:77:19
// at [eval]-wrapper:6:22
// at evalScript (node:internal/process/execution:76:60)
// at node:internal/main/eval_string:23:3
const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr

Example using the Console class:

const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);
myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err
const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to err

@seesource

console
.
Console.log(message?: any, ...optionalParams: any[]): void

Prints to stdout with newline. Multiple arguments can be passed, with the first used as the primary message and all additional used as substitution values similar to printf(3) (the arguments are all passed to util.format()).

const count = 5;
console.log('count: %d', count);
// Prints: count: 5, to stdout
console.log('count:', count);
// Prints: count: 5, to stdout

See util.format() for more information.

@sincev0.1.100

log
(`The poll with the id: ${
newMessage: Omit<Message, "tts"> & {
tts: false;
}
newMessage
.
id: string
id
} is ended`)
}
},
});

Comandos

Ejemplos rápidos de cómo crear una encuesta y cómo finalizarla.

Supongamos que tienes la siguiente estructura de directorios:

  • src
  • Directorycommands
    • Directorypoll
      • start.command.ts
      • end.command.ts
      • parent.ts
  • index.ts
  • seyfert.config.mjs
  • package.json
  • tsconfig.json
poll.parent.ts
import {
function AutoLoad(): <T extends {
new (...args: any[]): object;
}>(target: T) => {
new (...args: any[]): {
__autoload: boolean;
};
} & T
AutoLoad
,
function Declare(declare: CommandDeclareOptions): <T extends {
new (...args: any[]): object;
}>(target: T) => {
new (...args: any[]): {
name: string;
nsfw: boolean | undefined;
props: ExtraProps | undefined;
contexts: InteractionContextType[];
integrationTypes: ApplicationIntegrationType[];
defaultMemberPermissions: bigint | undefined;
botPermissions: bigint | undefined;
description: string;
type: ApplicationCommandType;
guildId?: string[];
ignore?: IgnoreCommand;
aliases?: string[];
handler?: EntryPointCommandHandlerType;
};
} & T
Declare
,
class Command
Command
} from 'seyfert';
@
function Declare(declare: CommandDeclareOptions): <T extends {
new (...args: any[]): object;
}>(target: T) => {
new (...args: any[]): {
name: string;
nsfw: boolean | undefined;
props: ExtraProps | undefined;
contexts: InteractionContextType[];
integrationTypes: ApplicationIntegrationType[];
defaultMemberPermissions: bigint | undefined;
botPermissions: bigint | undefined;
description: string;
type: ApplicationCommandType;
guildId?: string[];
ignore?: IgnoreCommand;
aliases?: string[];
handler?: EntryPointCommandHandlerType;
};
} & T
Declare
({
name: string
name
: 'poll',
description: string
description
: 'Poll command!',
})
@
function AutoLoad(): <T extends {
new (...args: any[]): object;
}>(target: T) => {
new (...args: any[]): {
__autoload: boolean;
};
} & T
AutoLoad
()
export default class
class PollCommand
PollCommand
extends
class Command
Command
{}