boma 2.0.0 → 2.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "boma",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Primitive JSON helper",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/readme.md

@@ -1,7 +1,7 @@
 # Boma JSON helper
  Super-simple helper for working with JSON
 
- Work only in synchronous mode.
+ Work only in synchronous mode for now.
 
 # Usage
 
@@ -14,10 +14,44 @@ logs = {
 }
 */
 
-saveJSON(filePath: string, objToSave: Serializable, format?: boolean); // Format for save line break's
+saveJSON({ filePath: '/test.json', objToSave: { any: {}, key: {} }, format: true, logSaving: false }); // Format for save line break's
+/* Will save:
+{
+  "any": {}, // saved line break's
+  "key": {}
+}
+*/
 
-addToJSON('/support.log', { 6sdf89g7dghg: { any: "data" } });
+addToJSON({ filePath: '/support.log', dataToAdd: { 6sdf89g7dghg: { any: "data" }}, format: false, logSaving: false });
 /* Will save:
 "{ "any": {}, "key": {}, "6sdf89g7dghg": { "any": "data" } }"
 */
 ```
+
+## Types
+```typescript
+export type SerializablePrimitive = string | number | boolean | null;
+export type SerializableArray = Serializable[];
+export type SerializableObject = { [key: string]: Serializable };
+export type Serializable = SerializablePrimitive | SerializableArray | SerializableObject;
+
+export interface ReadJSONProps {
+  filePath: string;
+  parseJSON?: boolean;
+  createIfNotFound?: boolean | SerializableObject | SerializableArray; // Файл с чем создать, если не создан
+}
+
+export interface SaveJSONProps {
+  filePath: string;
+  objToSave: Serializable;
+  format?: boolean
+  logSaving?: boolean;
+}
+
+export interface addToJSONProps {
+  filePath: string;
+  dataToAdd: SerializableObject | SerializableArray;
+  format?: boolean
+  logSaving?: boolean;
+}
+```