Return object or dynamic from a method

Question

I have created string to linq query library for internal company needs. We will use this library for querying over REST mainly, but it could be used in a lot of other different situations.

The gist of it is this, a user can create a query and put it in a url like this:

www.test.com/api/v1/users?query=$where[#eq(Name,Test)&&#gt(Id,12345)]$orderby[Name,-Id]

but they could also write something like this

www.test.com/api/v1/users?query=$where[#eq(Name,Test)&&#gt(Id,12345)]$last[]

$last[] returns a single object, while

$orderby[Name,-Id] returns a collection

In the library I have a method that will accept that string and accordingly will produce a collection or a single object, I am just not sure if that method should return a type of Object or dynamic.

Which is more suitable, which one's going to be less confusing for other devs?

Also, I'm thinking of releasing this lib as open source, but I don't know if there is a need for something like this to get released.

Answer 1

Instead of "last", if you implemented "orderbyDesc" and "take" (and maybe also "skip") then your queries could always return collections, but users would understand that to get to the last item they would need to fetch it via $where[#eq(Name,Test)&&#gt(Id,12345)]$orderbyDesc[Name,-Id]$take[1]

I wouldn't change the collection to a single object just because of the final parameter, that feels unatural. In C#, the LINQ methods for skip and take still return collections, so I'd follow that pattern.

Answer 2

You should read up on the differences between object and dynamic. Here's some info https://stackoverflow.com/questions/5523031/dynamic-keyword-vs-object-data-type and https://blogs.msdn.microsoft.com/csharpfaq/2010/01/25/what-is-the-difference-between-dynamic-and-object-keywords/

The biggest difference is that the compiler leaves dyanmic checking to the runtime. So compiler errors become runtime exceptions. For instance, this throws a compiler error:

object abc = new object();
abc.BadCall(); //compiler error

But this compiles without any errors and will throw a RuntimeBinderException exception:

//VVVVV ----- only changed "object" to "dynamic"
dynamic abc = new object();
abc.BadCall(); //runtime exception here

You'd rather have a compiler error than a runtime exception if you had the choice. Here you do.

---

I can think of two uses for the dynamic keyword:

1. You can use it to make Microsoft.Office.Interop.Excel calls more readable.
2. You can use as a replacement to the Visitor design pattern.

If my only choice was between object and dynamic and I could use them interchangeably, I'd pick object.