From 3afb4e017c9793c5902bdd52d557d30dc8ea2853 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Corn=C3=A9=20Dorrestijn?= Date: Fri, 15 Aug 2014 17:29:36 +0200 Subject: [PATCH] Added the getDataPath function to the app api docs --- docs/api/app.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/api/app.md b/docs/api/app.md index 7a6488556ed2..2c1288a4266b 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -87,6 +87,15 @@ executed. It is possible that a window cancels the quitting by returning Quit the application directly, it will not try to close all windows so cleanup code will not run. +## app.getDataPath() + +Returns the right data path for the OS appended with the app name. + + * `%APPDATA%\My App Name` (`C:\Users\[username]\AppData\Roaming\My App Name`) + in Windows + * `~/.config/My App Name` in Linux + * `/Users/[username]/Library/Application Support/My App Name` in OS X + ## app.getVersion() Returns the version of loaded application, if no version is found in