added comment about type

gmmorris · Sep 2, 2020 · 1f641c3 · 1f641c3
1 parent c9deb85
commit 1f641c3
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/x-pack/plugins/actions/server/saved_objects/saved_objects_client_without_updates.ts b/x-pack/plugins/actions/server/saved_objects/saved_objects_client_without_updates.ts
@@ -9,6 +9,11 @@ type AlertSavedObjectsCreateOptions = Omit<SavedObjectsCreateOptions, 'id' | 'ov
 type AlertSavedObjectsUpdateOptions = Omit<SavedObjectsCreateOptions, 'id' | 'overwrite'> &
   Pick<Required<SavedObjectsCreateOptions>, 'id' | 'overwrite'>;
 
+/**
+ * This type ensures that:
+ * 1. We never accidentally call `update`
+ * 2. We always specify `overwrite` when call `create` _with_ an `id`.
+ */
 export type SavedObjectsClientWithoutUpdates = Omit<
   SavedObjectsClientContract,
   'create' | 'update' | 'bulkUpdate'