{"id":19921246,"url":"https://github.com/lukasandreano/capacitor-cloudkit-api","last_synced_at":"2025-05-03T06:31:20.663Z","repository":{"id":245257440,"uuid":"817810747","full_name":"LukasAndreano/capacitor-cloudkit-api","owner":"LukasAndreano","description":"A capacitor plugin for using CloudKit Key-value APIs in Capacitor Apps","archived":false,"fork":false,"pushed_at":"2024-06-20T13:42:18.000Z","size":1011,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T12:49:31.308Z","etag":null,"topics":["capacitor","cloudkit","cloudkit-api","ios"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/capacitor-cloudkit-api","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LukasAndreano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-20T13:41:01.000Z","updated_at":"2024-06-20T15:47:13.000Z","dependencies_parsed_at":"2024-06-21T00:00:05.335Z","dependency_job_id":null,"html_url":"https://github.com/LukasAndreano/capacitor-cloudkit-api","commit_stats":null,"previous_names":["lukasandreano/capacitor-cloudkit-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukasAndreano%2Fcapacitor-cloudkit-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukasAndreano%2Fcapacitor-cloudkit-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukasAndreano%2Fcapacitor-cloudkit-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukasAndreano%2Fcapacitor-cloudkit-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LukasAndreano","download_url":"https://codeload.github.com/LukasAndreano/capacitor-cloudkit-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252154738,"owners_count":21702983,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["capacitor","cloudkit","cloudkit-api","ios"],"created_at":"2024-11-12T22:07:06.718Z","updated_at":"2025-05-03T06:31:16.223Z","avatar_url":"https://github.com/LukasAndreano.png","language":"Swift","readme":"# capacitor-cloudkit-api\n\nPlugin for using [Apple CloudKit Key-Value API](https://developer.apple.com/documentation/cloudkit/) in your Capacitor Apps.\n\n## Install\n\n```bash\nnpm install capacitor-cloudkit-api\nnpx cap sync\n```\n\n## Preparation\nAdd capability in `Signing \u0026 Capabilities` in Xcode project settings called `iCloud`:\n![](https://github.com/lukasandreano/capacitor-cloudkit-api/blob/main/docs/icloud.png?raw=true)\n\nNext, enable `Key-value storage` and `CloudKit` settings, and create any container by clicking on `+` button:\n![](https://github.com/lukasandreano/capacitor-cloudkit-api/blob/main/docs/cloudkit-settings.png?raw=true)\n\n## Usage\n```typescript\nimport {CapacitorCloudkitAPI} from 'capacitor-cloudkit-api';\n\nconst saveData = async (key: string, value: string): Promise\u003c{\n    key: string;\n    value: string;\n}\u003e =\u003e {\n    const result = await CapacitorCloudkitAPI.saveKeyValue({\n        key,\n        value,\n    });\n    \n    return result\n}\n\nconst getData = async (key: string): Promise\u003c{\n    key: string;\n    value: string;\n}\u003e =\u003e {\n    const result = await CapacitorCloudkitAPI.getKeyValue({\n        key\n    });\n\n    return result\n}\n```\n\n## API\n\n\u003cdocgen-index\u003e\n\n* [`saveKeyValue(...)`](#savekeyvalue)\n* [`getKeyValue(...)`](#getkeyvalue)\n\n\u003c/docgen-index\u003e\n\n\u003cdocgen-api\u003e\n\u003c!--Update the source file JSDoc comments and rerun docgen to update the docs below--\u003e\n\n### saveKeyValue(...)\n\n```typescript\nsaveKeyValue(options: { key: string; value: string; }) =\u003e Promise\u003c{ key: string; value: string; }\u003e\n```\n\n| Param         | Type                                         |\n| ------------- | -------------------------------------------- |\n| **`options`** | \u003ccode\u003e{ key: string; value: string; }\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ key: string; value: string; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\n### getKeyValue(...)\n\n```typescript\ngetKeyValue(options: { key: string; }) =\u003e Promise\u003c{ key: string; value: string; }\u003e\n```\n\n| Param         | Type                          |\n| ------------- | ----------------------------- |\n| **`options`** | \u003ccode\u003e{ key: string; }\u003c/code\u003e |\n\n**Returns:** \u003ccode\u003ePromise\u0026lt;{ key: string; value: string; }\u0026gt;\u003c/code\u003e\n\n--------------------\n\n\u003c/docgen-api\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukasandreano%2Fcapacitor-cloudkit-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flukasandreano%2Fcapacitor-cloudkit-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukasandreano%2Fcapacitor-cloudkit-api/lists"}