mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-08-15 11:01:21 +08:00
feat: Scoped Packages (#7911)
* chore: move tns-core-modules to nativescript-core * chore: preparing compat generate script * chore: add missing definitions * chore: no need for http-request to be private * chore: packages chore * test: generate tests for tns-core-modules * chore: add anroid module for consistency * chore: add .npmignore * chore: added privateModulesWhitelist * chore(webpack): added bundle-entry-points * chore: scripts * chore: tests changed to use @ns/core * test: add scoped-packages test project * test: fix types * test: update test project * chore: build scripts * chore: update build script * chore: npm scripts cleanup * chore: make the compat pgk work with old wp config * test: generate diff friendly tests * chore: create barrel exports * chore: move files after rebase * chore: typedoc config * chore: compat mode * chore: review of barrels * chore: remove tns-core-modules import after rebase * chore: dev workflow setup * chore: update developer-workflow * docs: experiment with API extractor * chore: api-extractor and barrel exports * chore: api-extractor configs * chore: generate d.ts rollup with api-extractor * refactor: move methods inside Frame * chore: fic tests to use Frame static methods * refactor: create Builder class * refactor: use Builder class in tests * refactor: include Style in ui barrel * chore: separate compat build script * chore: fix tslint errors * chore: update NATIVESCRIPT_CORE_ARGS * chore: fix compat pack * chore: fix ui-test-app build with linked modules * chore: Application, ApplicationSettings, Connectivity and Http * chore: export Trace, Profiling and Utils * refactor: Static create methods for ImageSource * chore: fix deprecated usages of ImageSource * chore: move Span and FormattedString to ui * chore: add events-args and ImageSource to index files * chore: check for CLI >= 6.2 when building for IOS * chore: update travis build * chore: copy Pod file to compat package * chore: update error msg ui-tests-app * refactor: Apply suggestions from code review Co-Authored-By: Martin Yankov <m.i.yankov@gmail.com> * chore: typings and refs * chore: add missing d.ts files for public API * chore: adress code review FB * chore: update api-report * chore: dev-workflow for other apps * chore: api update * chore: update api-report
This commit is contained in:

committed by
GitHub

parent
6c7139477e
commit
cc97a16800
3
nativescript-core/application-settings/Readme.md
Normal file
3
nativescript-core/application-settings/Readme.md
Normal file
@ -0,0 +1,3 @@
|
||||
|
||||
Used to store strings, booleans and numbers in built-in key/value store
|
||||
Uses SharedPreferences on Android and NSUserDefaults on iOS
|
@ -0,0 +1,11 @@
|
||||
export function checkKey(key: string): void {
|
||||
if (typeof key !== "string") {
|
||||
throw new Error("key: '" + key + "' must be a string");
|
||||
}
|
||||
}
|
||||
|
||||
export function ensureValidValue(value: any, valueType: string): void {
|
||||
if (typeof value !== valueType) {
|
||||
throw new Error("value: '" + value + "' must be a " + valueType);
|
||||
}
|
||||
}
|
@ -0,0 +1,104 @@
|
||||
import * as common from "./application-settings-common";
|
||||
import { getNativeApplication } from "../application";
|
||||
|
||||
let sharedPreferences: android.content.SharedPreferences;
|
||||
function ensureSharedPreferences() {
|
||||
if (!sharedPreferences) {
|
||||
sharedPreferences = (<android.app.Application>getNativeApplication()).getApplicationContext().getSharedPreferences("prefs.db", 0);
|
||||
}
|
||||
}
|
||||
|
||||
function verify(key: string) {
|
||||
common.checkKey(key);
|
||||
ensureSharedPreferences();
|
||||
}
|
||||
|
||||
export function hasKey(key: string): boolean {
|
||||
verify(key);
|
||||
|
||||
return sharedPreferences.contains(key);
|
||||
}
|
||||
|
||||
// getters
|
||||
export function getBoolean(key: string, defaultValue?: boolean): boolean {
|
||||
verify(key);
|
||||
if (hasKey(key)) {
|
||||
return sharedPreferences.getBoolean(key, false);
|
||||
}
|
||||
|
||||
return defaultValue;
|
||||
}
|
||||
|
||||
export function getString(key: string, defaultValue?: string): string {
|
||||
verify(key);
|
||||
if (hasKey(key)) {
|
||||
return sharedPreferences.getString(key, "");
|
||||
}
|
||||
|
||||
return defaultValue;
|
||||
}
|
||||
|
||||
export function getNumber(key: string, defaultValue?: number): number {
|
||||
verify(key);
|
||||
if (hasKey(key)) {
|
||||
return sharedPreferences.getFloat(key, float(0.0));
|
||||
}
|
||||
|
||||
return defaultValue;
|
||||
}
|
||||
|
||||
// setters
|
||||
export function setBoolean(key: string, value: boolean): void {
|
||||
verify(key);
|
||||
common.ensureValidValue(value, "boolean");
|
||||
const editor = sharedPreferences.edit();
|
||||
editor.putBoolean(key, value);
|
||||
editor.apply();
|
||||
}
|
||||
|
||||
export function setString(key: string, value: string): void {
|
||||
verify(key);
|
||||
common.ensureValidValue(value, "string");
|
||||
const editor = sharedPreferences.edit();
|
||||
editor.putString(key, value);
|
||||
editor.apply();
|
||||
}
|
||||
|
||||
export function setNumber(key: string, value: number): void {
|
||||
verify(key);
|
||||
common.ensureValidValue(value, "number");
|
||||
const editor = sharedPreferences.edit();
|
||||
editor.putFloat(key, float(value));
|
||||
editor.apply();
|
||||
}
|
||||
|
||||
export function remove(key: string): void {
|
||||
verify(key);
|
||||
const editor = sharedPreferences.edit();
|
||||
editor.remove(key);
|
||||
editor.apply();
|
||||
}
|
||||
|
||||
export function clear(): void {
|
||||
ensureSharedPreferences();
|
||||
sharedPreferences.edit().clear().apply();
|
||||
}
|
||||
|
||||
export function flush(): boolean {
|
||||
ensureSharedPreferences();
|
||||
|
||||
return sharedPreferences.edit().commit();
|
||||
}
|
||||
|
||||
export function getAllKeys(): Array<string> {
|
||||
ensureSharedPreferences();
|
||||
const mappedPreferences = sharedPreferences.getAll();
|
||||
const iterator = mappedPreferences.keySet().iterator();
|
||||
const result = [];
|
||||
while (iterator.hasNext()) {
|
||||
let key = iterator.next();
|
||||
result.push(key);
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
75
nativescript-core/application-settings/application-settings.d.ts
vendored
Normal file
75
nativescript-core/application-settings/application-settings.d.ts
vendored
Normal file
@ -0,0 +1,75 @@
|
||||
/**
|
||||
* Allows you to save and restore any kind of information related to your application.
|
||||
* @module "application-settings"
|
||||
*/ /** */
|
||||
|
||||
/**
|
||||
* Checks whether such a key exists.
|
||||
* @param key The key to check for.
|
||||
*/
|
||||
export function hasKey(key: string): boolean;
|
||||
|
||||
/**
|
||||
* Gets a value (if existing) for a key as a Boolean Object. A default value can be provided in case there is no existing value.
|
||||
* @param key The key to check for.
|
||||
* @param defaultValue An optional value to be returned in case there is no existing value.
|
||||
*/
|
||||
export function getBoolean(key: string, defaultValue?: boolean): boolean;
|
||||
|
||||
/**
|
||||
* Gets a value (if existing) for a key as a String Object. A default value can be provided in case there is no existing value.
|
||||
* @param key The key to check for.
|
||||
* @param defaultValue An optional value to be returned in case there is no existing value.
|
||||
*/
|
||||
export function getString(key: string, defaultValue?: string): string;
|
||||
|
||||
/**
|
||||
* Gets a value (if existing) for a key as a Number Object. A default value can be provided in case there is no existing value.
|
||||
* @param key The key to check for.
|
||||
* @param defaultValue An optional value to be returned in case there is no existing value.
|
||||
*/
|
||||
export function getNumber(key: string, defaultValue?: number): number;
|
||||
|
||||
/**
|
||||
* Sets a Boolean Object for a key.
|
||||
* @param key The key.
|
||||
* @param value The value.
|
||||
*/
|
||||
export function setBoolean(key: string, value: boolean): void;
|
||||
|
||||
/**
|
||||
* Sets a String Object for a key.
|
||||
* @param key The key.
|
||||
* @param value The value.
|
||||
*/
|
||||
export function setString(key: string, value: string): void;
|
||||
|
||||
/**
|
||||
* Sets a Number Object for a key.
|
||||
* @param key The key.
|
||||
* @param value The value.
|
||||
*/
|
||||
export function setNumber(key: string, value: number): void;
|
||||
|
||||
/**
|
||||
* Removes a value (if existing) for a key.
|
||||
* @param key The key to check for.
|
||||
*/
|
||||
export function remove(key: string): void;
|
||||
|
||||
/**
|
||||
* Removes all values.
|
||||
*/
|
||||
export function clear(): void;
|
||||
|
||||
/**
|
||||
* Flush all changes to disk synchronously.
|
||||
* @return boolean flag indicating if changes were saved successfully to disk.
|
||||
*/
|
||||
export function flush(): boolean;
|
||||
|
||||
/**
|
||||
* Get all stored keys
|
||||
* @return Array containing all stored keys
|
||||
*/
|
||||
export function getAllKeys(): Array<string>;
|
@ -0,0 +1,75 @@
|
||||
import * as Common from "./application-settings-common";
|
||||
|
||||
import * as utils from "../utils/utils";
|
||||
|
||||
const userDefaults = NSUserDefaults.standardUserDefaults;
|
||||
|
||||
export function hasKey(key: string): boolean {
|
||||
Common.checkKey(key);
|
||||
|
||||
return userDefaults.objectForKey(key) !== null;
|
||||
}
|
||||
|
||||
// utils.ios.getters
|
||||
export function getBoolean(key: string, defaultValue?: boolean): boolean {
|
||||
Common.checkKey(key);
|
||||
if (hasKey(key)) {
|
||||
return userDefaults.boolForKey(key);
|
||||
}
|
||||
|
||||
return defaultValue;
|
||||
}
|
||||
|
||||
export function getString(key: string, defaultValue?: string): string {
|
||||
Common.checkKey(key);
|
||||
if (hasKey(key)) {
|
||||
return userDefaults.stringForKey(key);
|
||||
}
|
||||
|
||||
return defaultValue;
|
||||
}
|
||||
|
||||
export function getNumber(key: string, defaultValue?: number): number {
|
||||
Common.checkKey(key);
|
||||
if (hasKey(key)) {
|
||||
return userDefaults.doubleForKey(key);
|
||||
}
|
||||
|
||||
return defaultValue;
|
||||
}
|
||||
|
||||
// setters
|
||||
export function setBoolean(key: string, value: boolean): void {
|
||||
Common.checkKey(key);
|
||||
Common.ensureValidValue(value, "boolean");
|
||||
userDefaults.setBoolForKey(value, key);
|
||||
}
|
||||
|
||||
export function setString(key: string, value: string): void {
|
||||
Common.checkKey(key);
|
||||
Common.ensureValidValue(value, "string");
|
||||
userDefaults.setObjectForKey(value, key);
|
||||
}
|
||||
|
||||
export function setNumber(key: string, value: number): void {
|
||||
Common.checkKey(key);
|
||||
Common.ensureValidValue(value, "number");
|
||||
userDefaults.setDoubleForKey(value, key);
|
||||
}
|
||||
|
||||
export function remove(key: string): void {
|
||||
Common.checkKey(key);
|
||||
userDefaults.removeObjectForKey(key);
|
||||
}
|
||||
|
||||
export function clear(): void {
|
||||
userDefaults.removePersistentDomainForName(NSBundle.mainBundle.bundleIdentifier);
|
||||
}
|
||||
|
||||
export function flush(): boolean {
|
||||
return userDefaults.synchronize();
|
||||
}
|
||||
|
||||
export function getAllKeys(): Array<string> {
|
||||
return utils.ios.collections.nsArrayToJSArray(userDefaults.dictionaryRepresentation().allKeys);
|
||||
}
|
6
nativescript-core/application-settings/package.json
Normal file
6
nativescript-core/application-settings/package.json
Normal file
@ -0,0 +1,6 @@
|
||||
{
|
||||
"name": "application-settings",
|
||||
"main": "application-settings",
|
||||
"types": "application-settings.d.ts",
|
||||
"nativescript": {}
|
||||
}
|
Reference in New Issue
Block a user