@projetoacbr/acbrlib-base-node 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +96 -16
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,17 +1,97 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
1
|
+
# @projetoacbr/acbrlib-base-node
|
|
2
|
+
|
|
3
|
+
[](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html)
|
|
4
|
+
[](https://www.npmjs.com/package/@projetoacbr/acbrlib-base-node)
|
|
5
|
+
[](https://www.typescriptlang.org/)
|
|
6
|
+
|
|
7
|
+
## 📋 Descrição
|
|
8
|
+
|
|
9
|
+
**ACBrLib Base Node** é o pacote fundamental que fornece funcionalidades básicas para todos os outros pacotes da família ACBrLib-Nodejs. Esta classe base implementa funcionalidades essenciais como inicialização, configuração e gerenciamento de memória.
|
|
10
|
+
|
|
11
|
+
## 🏗️ Arquitetura
|
|
12
|
+
|
|
13
|
+
Esta é a classe base (`ACBrLibBaseMT`) que serve como fundamento para toda a hierarquia de pacotes ACBrLib-Nodejs.
|
|
14
|
+
|
|
15
|
+
## 📦 Instalação
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install @projetoacbr/acbrlib-base-node
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## 📖 Como Usar
|
|
22
|
+
|
|
23
|
+
### Importação
|
|
24
|
+
|
|
25
|
+
```javascript
|
|
26
|
+
const ACBrLibBaseMT = require('@projetoacbr/acbrlib-base-node/dist/src').default
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Uso Básico
|
|
30
|
+
|
|
31
|
+
```javascript
|
|
32
|
+
// Esta classe é abstrata e não deve ser instanciada diretamente
|
|
33
|
+
// Use as classes específicas que herdam dela:
|
|
34
|
+
// - ACBrLibDFeComum
|
|
35
|
+
// - ACBrLibNFeMT
|
|
36
|
+
// - ACBrLibMDFeMT
|
|
37
|
+
// - ACBrLibNFSeMT
|
|
38
|
+
// - ACBrLibCepMT
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## 🔧 Funcionalidades
|
|
42
|
+
|
|
43
|
+
### Métodos Principais
|
|
44
|
+
|
|
45
|
+
- **Inicialização e Finalização**
|
|
46
|
+
- `inicializar(configPath, chaveCrypt)`
|
|
47
|
+
- `finalizar()`
|
|
48
|
+
|
|
49
|
+
- **Configuração**
|
|
50
|
+
- `configLer(arquivoConfig)`
|
|
51
|
+
- `configGravar(arquivoConfig)`
|
|
52
|
+
- `configLerValor(sessao, chave)`
|
|
53
|
+
- `configGravarValor(sessao, chave, valor)`
|
|
54
|
+
- `configImportar(arquivoConfig)`
|
|
55
|
+
- `configExportar()`
|
|
56
|
+
|
|
57
|
+
- **Informações do Sistema**
|
|
58
|
+
- `nome()`
|
|
59
|
+
- `versao()`
|
|
60
|
+
- `openSSLInfo()`
|
|
61
|
+
- `ultimoRetorno()`
|
|
62
|
+
|
|
63
|
+
- **Gerenciamento de Memória**
|
|
64
|
+
- `ACBrBuffer` - Classe para gerenciamento de buffers
|
|
65
|
+
- `TAMANHO_PADRAO` - Constante para tamanho padrão de buffer
|
|
66
|
+
|
|
67
|
+
## 🔗 Dependências
|
|
68
|
+
|
|
69
|
+
- **koffi** - Para interface com bibliotecas nativas
|
|
70
|
+
|
|
71
|
+
## 📚 Documentação
|
|
72
|
+
|
|
73
|
+
Para informações detalhadas sobre cada método, consulte a documentação JSDoc incluída no código fonte.
|
|
74
|
+
|
|
75
|
+
## 🤝 Contribuição
|
|
76
|
+
|
|
77
|
+
1. Fork o projeto
|
|
78
|
+
2. Crie uma branch para sua feature
|
|
79
|
+
3. Commit suas mudanças
|
|
80
|
+
4. Push para a branch
|
|
81
|
+
5. Abra um Pull Request
|
|
82
|
+
|
|
83
|
+
## 📞 Suporte
|
|
84
|
+
|
|
85
|
+
- **Issues**: [GitHub Issues](https://github.com/Projeto-ACBr-Oficial/ACBrLib-Nodejs/issues)
|
|
86
|
+
- **Documentação ACBrLib**: [https://acbr.sourceforge.io/ACBrLib/BemVindo.html](https://acbr.sourceforge.io/ACBrLib/BemVindo.html)
|
|
87
|
+
|
|
88
|
+
## 📄 Licença
|
|
89
|
+
|
|
90
|
+
LGPL-2.1 License - veja o arquivo [LICENSE](../LICENSE) para detalhes.
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
**ACBrLib Base Node** - Classe base fundamental para ACBrLib-Nodejs
|
|
95
|
+
**Versão**: 1.0.1
|
|
96
|
+
**Desenvolvido por**: [Projeto ACBr](https://www.projetoacbr.com.br/)
|
|
17
97
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@projetoacbr/acbrlib-base-node",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "dist/src/index.js",
|
|
6
6
|
"types": "dist/src/index.d.ts",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"url": "git+https://github.com/Projeto-ACBr-Oficial/ACBrLib-Nodejs.git"
|
|
18
18
|
},
|
|
19
19
|
"author": "",
|
|
20
|
-
"license": "
|
|
20
|
+
"license": "LGPL-2.1",
|
|
21
21
|
"bugs": {
|
|
22
22
|
"url": "https://github.com/Projeto-ACBr-Oficial/ACBrLib-Nodejs/issues"
|
|
23
23
|
},
|