Settings.md

Settings Service

read()

read(null, callback)

reads the settings from the local Stealth profile folder.

// read(payload) example
null

read({ internet: Boolean, filters: Boolean, hosts: Boolean, modes: Boolean, peers: Boolean }, callback)

reads the settings from the local Stealth profile folder, and responds only with the selected type.

// read(payload) example
{
	internet: true,
	hosts:    false, // not necessary, as it is defaulted
	peers:    true
}

By default, it assumes false for all types.

// read(payload) example
null // responds with all settings

save()

save({ internet: Object, filters: Array, hosts: Array, peers: Array, sites: Array }, callback)

saves the settings to the local Stealth profile folder.

All nested Arrays and Objects are applied incrementally to their existing settings. If there's already a configured setting with the same identifiers, it will be changed.

// save(payload) example
{
	// stored in profile/internet.json
	internet: {
		connection: 'mobile',
		torify: false
	},

	// stored in profile/filters.json
	// managed by Filter Service
	filters: [{
		domain: 'cookie.engineer',
		prefix: '/bad',
		midfix: null,
		suffix: '.advert.png'
	}],

	// stored in profile/hosts.json
	// managed by Host Service
	hosts: [{
		domain: 'cookie.engineer',
		ipv4:   '185.199.109.153'
		ipv6:   null
	}],

	// stored in profile/modes.json
	// managed by Mode Service
	modes: [{
		domain: 'old.reddit.com',
		mode:   {
			text:  true,
			image: true,
			audio: false,
			video: false,
			other: false
		}
	}],

	// stored in profile/peers.json
	// managed by Peer Service
	peers: [{
		domain:   'local-laptop', // can be either of domain, hostname, ipv4, ipv6
		capacity: 'online',
		mode:     'stealth'
	}]

}