Merge pull request #185 from joshnuss/add-ts-deprecated

joshnuss · web-flow · commit f5ba6bcb8edc · 2023-08-16T19:51:19.000-04:00
feat: use TS @deprecated for writable
diff --git a/index.ts b/index.ts
@@ -22,6 +22,7 @@ function getStorage(type: StorageType) {
   return type === 'local' ? localStorage : sessionStorage
 }
 
+/** @deprecated `writable()` has been renamed to `persisted()` */
 export function writable<T>(key: string, initialValue: T, options?: Options<T>): Writable<T> {
   console.warn("writable() has been deprecated. Please use persisted() instead.\n\nchange:\n\nimport { writable } from 'svelte-local-storage-store'\n\nto:\n\nimport { persisted } from 'svelte-local-storage-store'")
   return persisted<T>(key, initialValue, options)

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ function getStorage(type: StorageType) {`
`22`	`22`	`return type === 'local' ? localStorage : sessionStorage`
`23`	`23`	`}`
`24`	`24`
	`25`	+/** @deprecated `writable()` has been renamed to `persisted()` */
`25`	`26`	`export function writable<T>(key: string, initialValue: T, options?: Options<T>): Writable<T> {`
`26`	`27`	`console.warn("writable() has been deprecated. Please use persisted() instead.\n\nchange:\n\nimport { writable } from 'svelte-local-storage-store'\n\nto:\n\nimport { persisted } from 'svelte-local-storage-store'")`
`27`	`28`	`return persisted<T>(key, initialValue, options)`