Files
Hippy/ios/sdk/module/localstorage/HippyAsyncLocalStorage.h
T
luomy 87e2b66a8f Refactor/clang format (#592)
refactor(ios): add clang-format configuration and apply
2021-03-02 19:47:21 +08:00

49 lines
1.7 KiB
Objective-C

/*!
* iOS SDK
*
* Tencent is pleased to support the open source community by making
* Hippy available.
*
* Copyright (C) 2019 THL A29 Limited, a Tencent company.
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#import "HippyBridgeModule.h"
#import "HippyInvalidating.h"
/**
* A simple, asynchronous, persistent, key-value storage system designed as a
* backend to the AsyncStorage JS module, which is modeled after LocalStorage.
*
* Current implementation stores small values in serialized dictionary and
* larger values in separate files. Since we use a serial file queue
* `RKFileQueue`, reading/writing from multiple threads should be perceived as
* being atomic, unless someone bypasses the `HippyAsyncLocalStorage` API.
*
* Keys and values must always be strings or an error is returned.
*/
extern NSString *const HippyStorageDirectory;
@interface HippyAsyncLocalStorage : NSObject <HippyBridgeModule, HippyInvalidating>
@property (nonatomic, assign) BOOL clearOnInvalidate;
@property (nonatomic, readonly, getter=isValid) BOOL valid;
// Clear the HippyAsyncLocalStorage data from native code
+ (void)clearAllData;
- (NSString *)HippyGetStorageDirectory;
@end