docs(addon): setLogFilePath() method documented

SAP · Aug 17, 2023 · 9f10094 · 9f10094
1 parent a012dbc
commit 9f10094
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 15 deletions.
diff --git a/doc/api.md b/doc/api.md
@@ -69,6 +69,14 @@ Usage: [usage/addon](usage.md#addon)
 languageSapToIso(langSapCode: string): string|Error
 ```
 
+### setLogFilePath
+
+Usage: [usage/addon](usage.md#addon)
+
+```ts
+setLogFilePath(langSapCode: string): string|Error
+```
+
 ## Client
 
 Usage: [usage/client](usage.md#client)

diff --git a/src/cpp/Log.cc b/src/cpp/Log.cc
@@ -9,8 +9,8 @@ long long Log::timestamp() {
       .count();
 }
 
-void Log::set_log_file_name(const std::string& file_name) {
-  log_fname = file_name;
+void Log::set_log_file_path(const std::string& file_path) {
+  log_path = file_path;
 }
 
 void Log::set_log_level(const logClass component_id,
@@ -43,9 +43,9 @@ void Log::set_log_level(const logClass component_id,
   set_log_level(component_id, log_level);
 }
 
-Log::Log(std::string log_fname) : log_fname(log_fname) {
+Log::Log(std::string log_path) : log_path(log_path) {
   std::ofstream ofs;
-  ofs.open(log_fname, std::ofstream::out | std::ofstream::trunc);
+  ofs.open(log_path, std::ofstream::out | std::ofstream::trunc);
   ofs.close();
 }
 

diff --git a/src/cpp/Log.h b/src/cpp/Log.h
@@ -37,7 +37,7 @@ enum class logLevel {
 class Log {
  private:
   // Log file name
-  std::string log_fname;
+  std::string log_path;
 
   // Logging inactive by default
   std::unordered_map<logClass, logLevel> log_config = {
@@ -53,15 +53,15 @@ class Log {
 
  public:
   // Set log file name
-  void set_log_file_name(const std::string& file_name);
+  void set_log_file_path(const std::string& file_path);
 
   // Set log level
   void set_log_level(const logClass component_id, const logLevel log_level_id);
   void set_log_level(const logClass component_id,
                      const Napi::Value logLevelValue);
 
   // Default log filename
-  explicit Log(std::string log_fname = "_noderfc.log");
+  explicit Log(std::string log_path = "_noderfc.log");
   ~Log();
 
   // Write regular arguments. Must be defined in header becuse of variadic
@@ -85,7 +85,7 @@ class Log {
 
     // Write log message
     ofstream ofs;
-    ofs.open(log_fname.c_str(), ofstream::out | ios::app);
+    ofs.open(log_path.c_str(), ofstream::out | ios::app);
     ofs << endl
         << endl
         << date::format("%F %T", now) << " UTC [" << timestamp() << "] >> "
@@ -105,7 +105,7 @@ class Log {
     if (log_level_id > log_config[component_id]) {
       return;
     }
-    FILE* fp = fopen(log_fname.c_str(), "a");
+    FILE* fp = fopen(log_path.c_str(), "a");
     fprintf(fp, "%s", "'");
     fprintfU(fp, message);
     fprintf(fp, "%s", "'");

diff --git a/src/cpp/addon.cc b/src/cpp/addon.cc
@@ -112,8 +112,8 @@ Napi::Value LanguageSapToIso(const Napi::CallbackInfo& info) {
   return scope.Escape(wrapString(ucLangISO, 2));
 }
 
-Napi::Value SetLogFileName(const Napi::CallbackInfo& info) {
-  _log.set_log_file_name(info[0].As<Napi::String>().Utf8Value());
+Napi::Value SetLogFilePath(const Napi::CallbackInfo& info) {
+  _log.set_log_file_path(info[0].As<Napi::String>().Utf8Value());
   return info.Env().Undefined();
 }
 
@@ -123,7 +123,7 @@ Napi::Object RegisterModule(Napi::Env env, Napi::Object exports) {
   }
 
   exports.Set("bindingVersions", BindingVersions(env));
-  exports.Set("setLogFileName", Napi::Function::New(env, SetLogFileName));
+  exports.Set("setLogFilePath", Napi::Function::New(env, SetLogFilePath));
   exports.Set("setIniFileDirectory",
               Napi::Function::New(env, SetIniFileDirectory));
   exports.Set("loadCryptoLibrary", Napi::Function::New(env, LoadCryptoLibrary));

diff --git a/src/ts/index.ts b/src/ts/index.ts
@@ -46,8 +46,8 @@ export function loadCryptoLibrary(libAbsolutePath: string) {
     noderfc_binding.loadCryptoLibrary(libAbsolutePath);
 }
 
-export function setLogFileName(fileName: string) {
-    noderfc_binding.setLogFileName(fileName);
+export function setLogFilePath(filePath: string) {
+    noderfc_binding.setLogFilePath(filePath);
 }
 
 export const sapnwrfcEvents = new EventEmitter();

diff --git a/src/ts/noderfc-bindings.ts b/src/ts/noderfc-bindings.ts
@@ -43,7 +43,7 @@ export interface NWRfcBinding {
     languageIsoToSap(langIso: string): string | NWRfcSdkError;
     languageSapToIso(langSap: string): string | NWRfcSdkError;
     reloadIniFile(): undefined | NWRfcSdkError;
-    setLogFileName(fileName: string): unknown;
+    setLogFilePath(filePath: string): unknown;
     verbose(): this;
 }