kubernetes-fluent-client 1.5.0 → 1.5.1

package/dist/kinds.js

@@ -10,6 +10,7 @@ const gvkMap = {
      * Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not
      * rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued
      * existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data.
+     *
      * @see {@link https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/event-v1/}
      */
     CoreV1Event: {
@@ -20,6 +21,7 @@ const gvkMap = {
     /**
      * Represents a K8s ClusterRole resource.
      * ClusterRole is a set of permissions that can be bound to a user or group in a cluster-wide scope.
+     *
      * @see {@link https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole}
      */
     V1ClusterRole: {
@@ -30,6 +32,7 @@ const gvkMap = {
     /**
      * Represents a K8s ClusterRoleBinding resource.
      * ClusterRoleBinding binds a ClusterRole to a user or group in a cluster-wide scope.
+     *
      * @see {@link https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding}
      */
     V1ClusterRoleBinding: {
@@ -40,6 +43,7 @@ const gvkMap = {
     /**
      * Represents a K8s Role resource.
      * Role is a set of permissions that can be bound to a user or group in a namespace scope.
+     *
      * @see {@link https://kubernetes.io/docs/reference/access-authn-authz/rbac/#role-and-clusterrole}
      */
     V1Role: {
@@ -50,6 +54,7 @@ const gvkMap = {
     /**
      * Represents a K8s RoleBinding resource.
      * RoleBinding binds a Role to a user or group in a namespace scope.
+     *
      * @see {@link https://kubernetes.io/docs/reference/access-authn-authz/rbac/#rolebinding-and-clusterrolebinding}
      */
     V1RoleBinding: {
@@ -60,6 +65,7 @@ const gvkMap = {
     /**
      * Represents a K8s ConfigMap resource.
      * ConfigMap holds configuration data for pods to consume.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/configuration/configmap/}
      */
     V1ConfigMap: {
@@ -70,6 +76,7 @@ const gvkMap = {
     /**
      * Represents a K8s Endpoints resource.
      * Endpoints expose a service's IP addresses and ports to other resources.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/services-networking/service/#endpoints}
      */
     V1Endpoint: {
@@ -81,6 +88,7 @@ const gvkMap = {
     /**
      * Represents a K8s LimitRange resource.
      * LimitRange enforces constraints on the resource consumption of objects in a namespace.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/policy/limit-range/}
      */
     V1LimitRange: {
@@ -91,6 +99,7 @@ const gvkMap = {
     /**
      * Represents a K8s Namespace resource.
      * Namespace is a way to divide cluster resources between multiple users.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/}
      */
     V1Namespace: {
@@ -101,6 +110,7 @@ const gvkMap = {
     /**
      * Represents a K8s Node resource.
      * Node is a worker machine in Kubernetes.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/architecture/nodes/}
      */
     V1Node: {
@@ -111,6 +121,7 @@ const gvkMap = {
     /**
      * Represents a K8s PersistentVolumeClaim resource.
      * PersistentVolumeClaim is a user's request for and claim to a persistent volume.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims}
      */
     V1PersistentVolumeClaim: {
@@ -121,6 +132,7 @@ const gvkMap = {
     /**
      * Represents a K8s PersistentVolume resource.
      * PersistentVolume is a piece of storage in the cluster that has been provisioned by an administrator.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/storage/persistent-volumes/}
      */
     V1PersistentVolume: {
@@ -131,6 +143,7 @@ const gvkMap = {
     /**
      * Represents a K8s Pod resource.
      * Pod is the smallest and simplest unit in the Kubernetes object model.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/workloads/pods/}
      */
     V1Pod: {
@@ -141,6 +154,7 @@ const gvkMap = {
     /**
      * Represents a K8s PodTemplate resource.
      * PodTemplate is an object that describes the pod that will be created from a higher level abstraction.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/workloads/controllers/#pod-template}
      */
     V1PodTemplate: {
@@ -151,6 +165,7 @@ const gvkMap = {
     /**
      * Represents a K8s ReplicationController resource.
      * ReplicationController ensures that a specified number of pod replicas are running at any given time.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/}
      */
     V1ReplicationController: {
@@ -161,6 +176,7 @@ const gvkMap = {
     /**
      * Represents a K8s ResourceQuota resource.
      * ResourceQuota provides constraints that limit resource consumption per namespace.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/policy/resource-quotas/}
      */
     V1ResourceQuota: {
@@ -171,6 +187,7 @@ const gvkMap = {
     /**
      * Represents a K8s Secret resource.
      * Secret holds secret data of a certain type.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/configuration/secret/}
      */
     V1Secret: {
@@ -181,6 +198,7 @@ const gvkMap = {
     /**
      * Represents a K8s ServiceAccount resource.
      * ServiceAccount is an identity that processes in a pod can use to access the Kubernetes API.
+     *
      * @see {@link https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/}
      */
     V1ServiceAccount: {
@@ -191,6 +209,7 @@ const gvkMap = {
     /**
      * Represents a K8s Service resource.
      * Service is an abstraction which defines a logical set of Pods and a policy by which to access them.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/services-networking/service/}
      */
     V1Service: {
@@ -201,6 +220,7 @@ const gvkMap = {
     /**
      * Represents a K8s MutatingWebhookConfiguration resource.
      * MutatingWebhookConfiguration configures a mutating admission webhook.
+     *
      * @see {@link https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#configure-admission-webhooks-on-the-fly}
      */
     V1MutatingWebhookConfiguration: {
@@ -211,6 +231,7 @@ const gvkMap = {
     /**
      * Represents a K8s ValidatingWebhookConfiguration resource.
      * ValidatingWebhookConfiguration configures a validating admission webhook.
+     *
      * @see {@link https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#configure-admission-webhooks-on-the-fly}
      */
     V1ValidatingWebhookConfiguration: {
@@ -221,6 +242,7 @@ const gvkMap = {
     /**
      * Represents a K8s CustomResourceDefinition resource.
      * CustomResourceDefinition is a custom resource in a Kubernetes cluster.
+     *
      * @see {@link https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/}
      */
     V1CustomResourceDefinition: {
@@ -231,6 +253,7 @@ const gvkMap = {
     /**
      * Represents a K8s APIService resource.
      * APIService represents a server for a particular API version and group.
+     *
      * @see {@link https://kubernetes.io/docs/tasks/access-kubernetes-api/setup-extension-api-server/}
      */
     V1APIService: {
@@ -241,6 +264,7 @@ const gvkMap = {
     /**
      * Represents a K8s ControllerRevision resource.
      * ControllerRevision is used to manage the history of a StatefulSet or DaemonSet.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#revision-history}
      */
     V1ControllerRevision: {
@@ -251,6 +275,7 @@ const gvkMap = {
     /**
      * Represents a K8s DaemonSet resource.
      * DaemonSet ensures that all (or some) nodes run a copy of a Pod.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/}
      */
     V1DaemonSet: {
@@ -261,6 +286,7 @@ const gvkMap = {
     /**
      * Represents a K8s Deployment resource.
      * Deployment provides declarative updates for Pods and ReplicaSets.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/workloads/controllers/deployment/}
      */
     V1Deployment: {
@@ -271,6 +297,7 @@ const gvkMap = {
     /**
      * Represents a K8s ReplicaSet resource.
      * ReplicaSet ensures that a specified number of pod replicas are running at any given time.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/}
      */
     V1ReplicaSet: {
@@ -281,6 +308,7 @@ const gvkMap = {
     /**
      * Represents a K8s StatefulSet resource.
      * StatefulSet is used to manage stateful applications.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/}
      */
     V1StatefulSet: {
@@ -291,6 +319,7 @@ const gvkMap = {
     /**
      * Represents a K8s TokenReview resource.
      * TokenReview attempts to authenticate a token to a known user.
+     *
      * @see {@link https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#tokenreview-v1-authentication-k8s-io}
      */
     V1TokenReview: {
@@ -301,6 +330,7 @@ const gvkMap = {
     /**
      * Represents a K8s LocalSubjectAccessReview resource.
      * LocalSubjectAccessReview checks whether a specific user can perform a specific action in a specific namespace.
+     *
      * @see {@link https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#localsubjectaccessreview-v1-authorization-k8s-io}
      */
     V1LocalSubjectAccessReview: {
@@ -311,6 +341,7 @@ const gvkMap = {
     /**
      * Represents a K8s SelfSubjectAccessReview resource.
      * SelfSubjectAccessReview checks whether the current user can perform a specific action.
+     *
      * @see {@link https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#selfsubjectaccessreview-v1-authorization-k8s-io}
      */
     V1SelfSubjectAccessReview: {
@@ -321,6 +352,7 @@ const gvkMap = {
     /**
      * Represents a K8s SelfSubjectRulesReview resource.
      * SelfSubjectRulesReview lists the permissions a specific user has within a namespace.
+     *
      * @see {@link https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#selfsubjectrulesreview-v1-authorization-k8s-io}
      */
     V1SelfSubjectRulesReview: {
@@ -331,6 +363,7 @@ const gvkMap = {
     /**
      * Represents a K8s SubjectAccessReview resource.
      * SubjectAccessReview checks whether a specific user can perform a specific action.
+     *
      * @see {@link https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#subjectaccessreview-v1-authorization-k8s-io}
      */
     V1SubjectAccessReview: {
@@ -341,6 +374,7 @@ const gvkMap = {
     /**
      * Represents a K8s HorizontalPodAutoscaler resource.
      * HorizontalPodAutoscaler automatically scales the number of Pods in a replication controller, deployment, or replica set.
+     *
      * @see {@link https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/}
      */
     V1HorizontalPodAutoscaler: {
@@ -351,6 +385,7 @@ const gvkMap = {
     /**
      * Represents a K8s CronJob resource.
      * CronJob manages time-based jobs, specifically those that run periodically and complete after a successful execution.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/}
      */
     V1CronJob: {
@@ -361,6 +396,7 @@ const gvkMap = {
     /**
      * Represents a K8s Job resource.
      * Job represents the configuration of a single job.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/workloads/controllers/job/}
      */
     V1Job: {
@@ -371,6 +407,7 @@ const gvkMap = {
     /**
      * Represents a K8s CertificateSigningRequest resource.
      * CertificateSigningRequest represents a certificate signing request.
+     *
      * @see {@link https://kubernetes.io/docs/reference/access-authn-authz/certificate-signing-requests/}
      */
     V1CertificateSigningRequest: {
@@ -381,6 +418,7 @@ const gvkMap = {
     /**
      * Represents a K8s EndpointSlice resource.
      * EndpointSlice represents a scalable set of network endpoints for a Kubernetes Service.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/services-networking/endpoint-slices/}
      */
     V1EndpointSlice: {
@@ -391,6 +429,7 @@ const gvkMap = {
     /**
      * Represents a K8s IngressClass resource.
      * IngressClass represents the class of the Ingress, referenced by the Ingress spec.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/services-networking/ingress/}
      */
     V1IngressClass: {
@@ -401,6 +440,7 @@ const gvkMap = {
     /**
      * Represents a K8s Ingress resource.
      * Ingress exposes HTTP and HTTPS routes from outside the cluster to services within the cluster.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/services-networking/ingress/}
      */
     V1Ingress: {
@@ -412,6 +452,7 @@ const gvkMap = {
     /**
      * Represents a K8s NetworkPolicy resource.
      * NetworkPolicy defines a set of rules for how pods communicate with each other.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/services-networking/network-policies/}
      */
     V1NetworkPolicy: {
@@ -422,6 +463,7 @@ const gvkMap = {
     /**
      * Represents a K8s RuntimeClass resource.
      * RuntimeClass is a cluster-scoped resource that surfaces container runtime properties to the control plane.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/containers/runtime-class/}
      */
     V1RuntimeClass: {
@@ -432,6 +474,7 @@ const gvkMap = {
     /**
      * Represents a K8s PodDisruptionBudget resource.
      * PodDisruptionBudget is an API object that limits the number of pods of a replicated application that are down simultaneously.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/workloads/pods/disruptions/}
      */
     V1PodDisruptionBudget: {
@@ -442,6 +485,7 @@ const gvkMap = {
     /**
      * Represents a K8s VolumeAttachment resource.
      * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/storage/storage-classes/}
      */
     V1VolumeAttachment: {
@@ -452,6 +496,7 @@ const gvkMap = {
     /**
      * Represents a K8s CSIDriver resource.
      * CSIDriver captures information about a Container Storage Interface (CSI) volume driver.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/storage/volumes/}
      */
     V1CSIDriver: {
@@ -462,6 +507,7 @@ const gvkMap = {
     /**
      * Represents a K8s CSIStorageCapacity resource.
      * CSIStorageCapacity stores the reported storage capacity of a CSI node or storage class.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/storage/csi/}
      */
     V1CSIStorageCapacity: {
@@ -472,6 +518,7 @@ const gvkMap = {
     /**
      * Represents a K8s StorageClass resource.
      * StorageClass is a cluster-scoped resource that provides a way for administrators to describe the classes of storage they offer.
+     *
      * @see {@link https://kubernetes.io/docs/concepts/storage/storage-classes/}
      */
     V1StorageClass: {
@@ -480,6 +527,12 @@ const gvkMap = {
         group: "storage.k8s.io",
     },
 };
+/**
+ * Converts a model name to a GroupVersionKind
+ *
+ * @param key The name of the model
+ * @returns The GroupVersionKind for the model
+ */
 function modelToGroupVersionKind(key) {
     return gvkMap[key];
 }

package/dist/types.d.ts

@@ -15,7 +15,7 @@ export declare class GenericKind implements KubernetesObject {
 /**
  * GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion
  * to avoid automatic coercion. It doesn't use a GroupVersion to avoid custom marshalling
- **/
+ */
 export interface GroupVersionKind {
     /** The K8s resource kind, e..g "Pod". */
     readonly kind: string;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEzE,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAGjF,MAAM,MAAM,YAAY,GAAG,QAAQ,WAAW,GAAG,CAAC;AAElD;;;;GAIG;AACH,qBAAa,WAAY,YAAW,gBAAgB;IAClD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,YAAY,CAAC;IAExB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;IAGI;AACJ,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,6EAA6E;IAC7E,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,KAAK;IAEpB,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACjE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACrD,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;CACvC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEzE,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAGjF,MAAM,MAAM,YAAY,GAAG,QAAQ,WAAW,GAAG,CAAC;AAElD;;;;GAIG;AACH,qBAAa,WAAY,YAAW,gBAAgB;IAClD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,YAAY,CAAC;IAExB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,6EAA6E;IAC7E,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,KAAK;IAEpB,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACjE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IACrD,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;CACvC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kubernetes-fluent-client",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,8 +9,8 @@
     "build": "tsc",
     "semantic-release": "semantic-release",
     "test": "jest src --coverage",
-    "format:check": "eslint && prettier . --check",
-    "format:fix": "eslint --fix && prettier . --write"
+    "format:check": "eslint src && prettier . --check",
+    "format:fix": "eslint --fix src && prettier . --write"
   },
   "engines": {
     "node": ">=18.0.0"
@@ -48,6 +48,7 @@
     "@types/byline": "4.2.34",
     "@typescript-eslint/eslint-plugin": "6.7.4",
     "@typescript-eslint/parser": "6.7.4",
+    "eslint-plugin-jsdoc": "46.8.2",
     "jest": "29.7.0",
     "nock": "13.3.3",
     "prettier": "3.0.3",

package/src/fetch.ts

@@ -22,7 +22,7 @@ export type FetchResponse<T> = {
  *
  * @param url The URL or Request object to fetch
  * @param init Additional options for the request
- * @returns
+ * @returns The parsed JSON response
  */
 export async function fetch<T>(
   url: URL | RequestInfo,

package/src/fluent/index.ts

@@ -8,16 +8,17 @@ import type { PartialDeep } from "type-fest";
 
 import { modelToGroupVersionKind } from "../kinds";
 import { GenericClass } from "../types";
+import { ApplyCfg } from "./apply";
 import { Filters, K8sInit, Paths, WatchAction } from "./types";
 import { k8sExec } from "./utils";
 import { ExecWatch, WatchCfg } from "./watch";
-import { ApplyCfg } from "./apply";
 
 /**
  * Kubernetes fluent API inspired by Kubectl. Pass in a model, then call filters and actions on it.
  *
  * @param model - the model to use for the API
  * @param filters - (optional) filter overrides, can also be chained
+ * @returns a fluent API for the model
  */
 export function K8s<T extends GenericClass, K extends KubernetesObject = InstanceType<T>>(
   model: T,
@@ -26,27 +27,44 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
   const withFilters = { WithField, WithLabel, Get, Delete, Watch };
   const matchedKind = filters.kindOverride || modelToGroupVersionKind(model.name);
 
-  function InNamespace(namespaces: string) {
+  /**
+   * @inheritdoc
+   * @see {@link K8sInit.InNamespace}
+   */
+  function InNamespace(namespace: string) {
     if (filters.namespace) {
       throw new Error(`Namespace already specified: ${filters.namespace}`);
     }
 
-    filters.namespace = namespaces;
+    filters.namespace = namespace;
     return withFilters;
   }
 
+  /**
+   * @inheritdoc
+   * @see {@link K8sInit.WithField}
+   */
   function WithField<P extends Paths<K>>(key: P, value: string) {
     filters.fields = filters.fields || {};
     filters.fields[key] = value;
     return withFilters;
   }
 
+  /**
+   * @inheritdoc
+   * @see {@link K8sInit.WithLabel}
+   */
   function WithLabel(key: string, value: string) {
     filters.labels = filters.labels || {};
     filters.labels[key] = value;
     return withFilters;
   }
 
+  /**
+   * Sync the filters with the provided payload.
+   *
+   * @param payload - the payload to sync with
+   */
   function syncFilters(payload: K) {
     // Ensure the payload has metadata
     payload.metadata = payload.metadata || {};
@@ -70,6 +88,10 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
 
   async function Get(): Promise<KubernetesListObject<K>>;
   async function Get(name: string): Promise<K>;
+  /**
+   * @inheritdoc
+   * @see {@link K8sInit.Get}
+   */
   async function Get(name?: string) {
     if (name) {
       if (filters.name) {
@@ -81,6 +103,10 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
     return k8sExec<T, K | KubernetesListObject<K>>(model, filters, "GET");
   }
 
+  /**
+   * @inheritdoc
+   * @see {@link K8sInit.Delete}
+   */
   async function Delete(filter?: K | string): Promise<void> {
     if (typeof filter === "string") {
       filters.name = filter;
@@ -101,6 +127,10 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
     }
   }
 
+  /**
+   * @inheritdoc
+   * @see {@link K8sInit.Apply}
+   */
   async function Apply(
     resource: PartialDeep<K>,
     applyCfg: ApplyCfg = { force: false },
@@ -109,11 +139,19 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
     return k8sExec(model, filters, "APPLY", resource, applyCfg);
   }
 
+  /**
+   * @inheritdoc
+   * @see {@link K8sInit.Create}
+   */
   async function Create(resource: K): Promise<K> {
     syncFilters(resource);
     return k8sExec(model, filters, "POST", resource);
   }
 
+  /**
+   * @inheritdoc
+   * @see {@link K8sInit.Patch}
+   */
   async function Patch(payload: Operation[]): Promise<K> {
     // If there are no operations, throw an error
     if (payload.length < 1) {
@@ -123,6 +161,10 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
     return k8sExec<T, K>(model, filters, "PATCH", payload);
   }
 
+  /**
+   * @inheritdoc
+   * @see {@link K8sInit.Watch}
+   */
   async function Watch(callback: WatchAction<T>, watchCfg?: WatchCfg) {
     return ExecWatch(model, filters, callback, watchCfg);
   }

package/src/fluent/types.ts

@@ -28,6 +28,14 @@ export interface Filters {
   namespace?: string;
 }
 
+/**
+ * Get the resource or resources matching the filters.
+ * If no filters are specified, all resources will be returned.
+ * If a name is specified, only a single resource will be returned.
+ *
+ * @param name - (optional) the name of the resource to get
+ * @returns the resource or list of resources
+ */
 export type GetFunction<K extends KubernetesObject> = {
   (): Promise<KubernetesListObject<K>>;
   (name: string): Promise<K>;
@@ -42,16 +50,18 @@ export type K8sFilteredActions<K extends KubernetesObject> = {
   Get: GetFunction<K>;
 
   /**
-   * Delete the resource if it exists.
+   * Delete the resource matching the filters.
    *
    * @param filter - the resource or resource name to delete
    */
   Delete: (filter?: K | string) => Promise<void>;
 
   /**
+   * Watch the resource matching the filters.
    *
-   * @param callback
-   * @returns
+   * @param callback - the callback function to call when an event occurs
+   * @param watchCfg - (optional) watch configuration
+   * @returns a watch controller
    */
   Watch: (
     callback: (payload: K, phase: WatchPhase) => void,
@@ -63,16 +73,17 @@ export type K8sUnfilteredActions<K extends KubernetesObject> = {
   /**
    * Perform a server-side apply of the provided K8s resource.
    *
-   * @param resource
-   * @returns
+   * @param resource - the resource to apply
+   * @param applyCfg - (optional) apply configuration
+   * @returns the applied resource
    */
   Apply: (resource: PartialDeep<K>, applyCfg?: ApplyCfg) => Promise<K>;
 
   /**
    * Create the provided K8s resource or throw an error if it already exists.
    *
-   * @param resource
-   * @returns
+   * @param resource - the resource to create
+   * @returns the created resource
    */
   Create: (resource: K) => Promise<K>;
 
@@ -94,18 +105,18 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
    *
    * ```ts
    * K8s(kind.Deployment)
-   *  .WithField("metadata.name", "bar")
-   *  .WithField("metadata.namespace", "qux")
-   *  .Delete(...)
+   * .WithField("metadata.name", "bar")
+   * .WithField("metadata.namespace", "qux")
+   * .Delete(...)
    * ```
    *
    * Will only delete the Deployment if it has the `metadata.name=bar` and `metadata.namespace=qux` fields.
    * Not all fields are supported, see https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/#supported-fields,
    * but Typescript will limit to only fields that exist on the resource.
    *
-   * @param key  The field key
-   * @param value The field value
-   * @returns
+   * @param key - the field key
+   * @param value - the field value
+   * @returns the fluent API
    */
   WithField: <P extends Paths<K>>(key: P, value: string) => K8sWithFilters<K>;
 
@@ -115,15 +126,16 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
    *
    * ```ts
    * K8s(kind.Deployment)
-   *   .WithLabel("foo", "bar")
-   *   .WithLabel("baz", "qux")
-   *   .Delete(...)
+   * .WithLabel("foo", "bar")
+   * .WithLabel("baz", "qux")
+   * .Delete(...)
    * ```
    *
    * Will only delete the Deployment if it has the`foo=bar` and `baz=qux` labels.
    *
-   * @param key The label key
-   * @param value (optional) The label value
+   * @param key - the label key
+   * @param value - the label value
+   * @returns the fluent API
    */
   WithLabel: (key: string, value: string) => K8sWithFilters<K>;
 };
@@ -131,10 +143,10 @@ export type K8sWithFilters<K extends KubernetesObject> = K8sFilteredActions<K> &
 export type K8sInit<K extends KubernetesObject> = K8sWithFilters<K> &
   K8sUnfilteredActions<K> & {
     /**
-     * Filter the query by the given namespace.
+     * Set the namespace filter.
      *
-     * @param namespace
-     * @returns
+     * @param namespace - the namespace to filter on
+     * @returns the fluent API
      */
     InNamespace: (namespace: string) => K8sWithFilters<K>;
   };