forked from sidtagirisa/swift-parser
/
index.ts
50 lines (48 loc) · 1.61 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/*
* Copyright 2016 Alexander Tsybulsky and other contributors
* Copyright 2020 Centrapay and other contributors
* Copyright 2023 Stitch and other contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* MT940 parser
* @module swiftmessageparser
*/
import Parser from "./lib/parser";
const parser = new Parser();
/**
* Parse a SWIFT MT940, MT942, MT900 or MT910 statement message.
*
* @function
* @param {object} opts
* @param {string} opts.data - SWIFT message
* @param {string} opts.type - message format: mt940, mt942, mt900 or mt910
* @param {boolean} [opts.validate=false] - check for semantic errors
* @returns {array<Statement>} Array of statements
*
* @example
* import 'parser' from 'swiftmessageparser';
* const statements = parser.parse({
* type: 'mt940',
* data: fs.readFileSync(path, 'utf8'),
* });
*
* statements.forEach(stmt => {
* console.log(stmt.statementDate, stmt.accountIdentification, stmt.number.statement);
* stmt.transactions.forEach(txn => {
* console.log(txn.amount, txn.currency);
* };
* };
*/
export default { parse: parser.parse.bind(parser) };