open-nfse / NfseClientConfig

Interface: NfseClientConfig

Defined in: src/client.ts:123

Properties

Property	Modifier	Type	Description	Defined in
ambiente	readonly	Ambiente	-	src/client.ts:124
cepValidator?	readonly	CepValidator	Validador de CEP usado nas emissões deste cliente. Se omitido, a lib usa o createViaCepValidator() internamente (consulta viacep.com.br com cache em memória). Passe um custom para trocar o provedor (BrasilAPI, banco local, mock em tests).	src/client.ts:141
certificado	readonly	CertificateInput	-	src/client.ts:125
dispatcher?	readonly	Dispatcher	Advanced / testing hook. When set, used as the HTTP dispatcher instead of building an mTLS Agent from certificado (e.g. pass undici's MockAgent). Normal consumers should never need this.	src/client.ts:134
dpsCounter?	readonly	DpsCounter	Provedor atômico do próximo nDPS. Obrigatório para emitir(params) — o novo fluxo consulta esse provider depois das validações offline passarem. emitirDpsPronta(dps) não usa.	src/client.ts:153
emitente?	readonly	EmitenteConfig	-	src/client.ts:126
logger?	readonly	Logger	-	src/client.ts:128
parametrosCache?	readonly	ParametrosCache	Cache opcional para respostas da API de Parâmetros Municipais. Se omitido e useCache não for false em cada chamada, a lib usa um createInMemoryParametrosCache() implícito. Para cache compartilhada entre processos, passe uma impl de Redis/Memcached.	src/client.ts:160
retryPolicy?	readonly	RetryPolicy	Política de retry — decide o notBefore para cada erro transiente (respeitando Retry-After quando o servidor envia). Se omitida, a lib usa createDefaultRetryPolicy() (default 60s para 429/503 sem header, cap de 1h para valores absurdos).	src/client.ts:167
retryStore?	readonly	RetryStore	Store para eventos pendentes de retry. Necessário para emitir() e substituir() persistirem falhas transientes/rollbacks. Se omitido, a lib lança MissingRetryStoreError quando o caminho transiente é acionado.	src/client.ts:147
timeoutMs?	readonly	number	-	src/client.ts:127