@scidu/ts-configms-connector-lib
v1.0.5
Published
A TypeScript library for managing gRPC connections and tenant services.
Maintainers
Readme
ts-configms-connector-lib
Este projeto é uma biblioteca TypeScript que fornece uma interface para interagir com um serviço gRPC relacionado a tenants. A biblioteca inclui funcionalidades para gerenciar conexões gRPC, definir modelos de dados e realizar chamadas de serviço.
Estrutura do Projeto
src/client.ts: Contém a classe
ConfigClient, que gerencia a conexão com o serviço gRPC. Possui métodos para conectar ao serviço e buscar informações sobre tenants.- Métodos públicos:
static async connect(target: string, env: "dev" | "hml" | "prod", tlsCfg?: TLSConfig): Promise<ConfigClient>async getTenant(tenantId: string): Promise<any>close(): void
- Métodos públicos:
src/index.ts: Exporta todos os módulos do diretório
src, permitindo que sejam utilizados em outros arquivos.src/tls.ts: Define a interface
TLSConfige a funçãocreateTLSCredentials, que cria credenciais TLS a partir de um objeto de configuração.- Exportações:
interface TLSConfigfunction createTLSCredentials(cfg: TLSConfig): grpc.ChannelCredentials
- Exportações:
src/types/index.ts: Este arquivo pode ser utilizado para definir tipos e interfaces adicionais que podem ser necessários para o projeto, mas atualmente está vazio.
proto/tenant.proto: Define a estrutura do serviço gRPC e as mensagens utilizadas. Inclui a definição do serviço
TenantServicee as mensagensTenant,Theme,ServiceeGetTenantRequest.tsconfig.json: Configuração do TypeScript, especificando as opções do compilador, como o alvo, o módulo, e os diretórios de inclusão e exclusão.
package.json: Configuração do npm, listando as dependências do projeto, scripts e informações sobre o projeto.
Como Usar
Instale as dependências do projeto:
npm installCompile o projeto:
npm run buildExecute o cliente:
npm start
Contribuição
Contribuições são bem-vindas! Sinta-se à vontade para abrir uma issue ou enviar um pull request.
