package jsonmerge

Import Path
	github.com/apapsch/go-jsonmerge/v2 (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	  d doc.go
		Package jsonmerge helps mergeing JSON objects
		
		For example you have this documents:
		
		original.json
		 {
		   "number": 1,
		   "string": "value",
		   "object": {
		     "number": 1,
		       "string": "value",
		       "nested object": {
		         "number": 2
		       },
		       "array": [1, 2, 3],
		       "partial_array": [1, 2, 3]
		    }
		 }
		
		patch.json
		 {
		   "number": 2,
		   "string": "value1",
		   "nonexitent": "woot",
		   "object": {
		     "number": 3,
		     "string": "value2",
		     "nested object": {
		       "number": 4
		     },
		     "array": [3, 2, 1],
		     "partial_array": {
		       "1": 4
		     }
		   }
		 }
		
		After merge you will have this result:
		 {
		   "number": 2,
		   "string": "value1",
		   "object": {
		     "number": 3,
		     "string": "value2",
		     "nested object": {
		       "number": 4
		     },
		     "array": [3, 2, 1],
		     "partial_array": [1, 4, 3]
		   }
		 }

	    merge.go
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Merger (struct)
		Merger describes result of merge operation and provides
		configuration.

		Fields (total 3, all are exported)
			CopyNonexistent bool
				CopyNonexistent enables setting fields into the result
				which only exist in the patch.

			Errors []error
				Errors is slice of non-critical errors of merge operations

			Replaced map[string]interface{}
				Replaced is describe replacements
				Key is path in document like
				  "prop1.prop2.prop3" for object properties or
				  "arr1.1.prop" for arrays
				Value is value of replacemet

		Methods (total 5, in which 3 are exported)
			(*Merger) Merge(data, patch interface{}) interface{}
				Merge merges patch document to data document
				
				Returning merged document. Result of merge operation can be
				obtained from the Merger. Result information is discarded before
				merging.

			(*Merger) MergeBytes(dataBuff, patchBuff []byte) (mergedBuff []byte, err error)
				MergeBytes merges patch document buffer to data document buffer
				
				Returning merged document buffer, merge info and
				error if any

			(*Merger) MergeBytesIndent(dataBuff, patchBuff []byte, prefix, indent string) (mergedBuff []byte, err error)
				MergeBytesIndent merges patch document buffer to data document buffer
				
				Use prefix and indent for set indentation like in json.MarshalIndent
				
				Returning merged document buffer and error if any.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*Merger) mergeObjects(data, patch interface{}, path []string) interface{}
			(*Merger) mergeValue(path []string, patch map[string]interface{}, key string, value interface{}) interface{}


Package-Level Functions (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	 func unmarshalJSON(buff []byte, data interface{}) error

The pages are generated with Golds v0.7.6. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.