@stone-ton/engajamenton
v1.0.1
Published
TypeScript definitions and utility functions for interacting with the `engajamenton` service, reducing code duplication across clients.
Downloads
7
Readme
@stone-ton/engajamenton
@stone-ton/engajamenton
é uma biblioteca TypeScript que fornece um cliente para interagir com o microserviço engajamenton
. Ela simplifica a comunicação com o serviço, abstraindo os detalhes da invocação de funções AWS Lambda, permitindo que os desenvolvedores se concentrem na lógica de negócio sem se preocupar com a infraestrutura subjacente.
Instalação
Você pode instalar o pacote via npm ou yarn:
npm install @stone-ton/engajamenton
ou
yarn add @stone-ton/engajamenton
Uso
Aqui está um exemplo básico de como usar o cliente Engajamenton
:
import { Engajamenton, UserExperiment } from '@stone-ton/engajamenton';
const engajamenton = new Engajamenton({
experimentLambda: 'nome-da-funcao-lambda',
awsRegion: 'sua-regiao-aws'
});
const userExperiments: UserExperiment[] = await engajamenton.getUserExperiments({
userId: 'id-do-usuario',
experiments: ['experimento-1', 'experimento-2'],
requestId: 'id-unico-da-requisicao'
});
Parâmetros do Construtor
experimentLambda
: (string) - O nome da função AWS Lambda que busca os experimentos.awsRegion
: (string, opcional) - A região AWS onde a função Lambda está implantada.
Métodos
getUserExperiments({ userId, experiments, requestId })
Busca os experimentos para um usuário específico.
- Parâmetros:
userId
: (string) - O ID do usuário cujos experimentos você deseja buscar.experiments
: (string[]) - Um array de identificadores de experimentos a serem buscados.requestId
: (string) - Um identificador único para a requisição.
- Retorna:
Promise<UserExperiment[]>
- Uma promessa que resolve para um array de objetosUserExperiment
.