Added typespecs - #11

Author: ankane

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.3.2 (unreleased)
+
+- Added typespecs
+
 ## 0.3.1 (2025-06-23)
 
 - Added support for Elixir 1.19

lib/pgvector.ex

@@ -3,6 +3,11 @@ defmodule Pgvector do
   A vector struct for pgvector
   """
 
+  @typedoc """
+  A vector
+  """
+  @type t :: %Pgvector{data: binary()}
+
   defstruct [:data]
 
   @doc """

lib/pgvector/ecto/half_vector.ex

@@ -2,6 +2,8 @@ if Code.ensure_loaded?(Ecto) do
   defmodule Pgvector.Ecto.HalfVector do
     use Ecto.Type
 
+    @type t :: Pgvector.HalfVector.t()
+
     def type, do: :halfvec
 
     def cast(value) do

lib/pgvector/ecto/sparse_vector.ex

@@ -2,6 +2,8 @@ if Code.ensure_loaded?(Ecto) do
   defmodule Pgvector.Ecto.SparseVector do
     use Ecto.Type
 
+    @type t :: Pgvector.SparseVector.t()
+
     def type, do: :sparsevec
 
     def cast(value) do

lib/pgvector/ecto/vector.ex

@@ -2,7 +2,7 @@ if Code.ensure_loaded?(Ecto) do
   defmodule Pgvector.Ecto.Vector do
     use Ecto.Type
 
-    @type t :: %Pgvector{data: binary()}
+    @type t :: Pgvector.t()
 
     def type, do: :vector
 

lib/pgvector/half_vector.ex

@@ -3,6 +3,11 @@ defmodule Pgvector.HalfVector do
   A half vector struct for pgvector
   """
 
+  @typedoc """
+  A half vector
+  """
+  @type t :: %Pgvector.HalfVector{data: binary()}
+
   defstruct [:data]
 
   @doc """

lib/pgvector/sparse_vector.ex

@@ -3,6 +3,11 @@ defmodule Pgvector.SparseVector do
   A sparse vector struct for pgvector
   """
 
+  @typedoc """
+  A sparse vector
+  """
+  @type t :: %Pgvector.SparseVector{data: binary()}
+
   defstruct [:data]
 
   @doc """